summaryrefslogtreecommitdiffstats
path: root/crawl-ref/source/makefile
diff options
context:
space:
mode:
authorAdam Borowski <kilobyte@angband.pl>2009-11-09 13:26:01 +0100
committerAdam Borowski <kilobyte@angband.pl>2009-11-09 13:38:40 +0100
commit9f0a0fc8b4b73cd1a6c1f4c8d2cdaced807c4f45 (patch)
tree6905328f3398eb15ae85060b27ae5dca65a83193 /crawl-ref/source/makefile
parent8881d4e48cb4ec1484fdab336c8fa6636d735513 (diff)
downloadcrawl-ref-9f0a0fc8b4b73cd1a6c1f4c8d2cdaced807c4f45.tar.gz
crawl-ref-9f0a0fc8b4b73cd1a6c1f4c8d2cdaced807c4f45.zip
Document most commonly used build arguments in a handy place.
Diffstat (limited to 'crawl-ref/source/makefile')
-rw-r--r--crawl-ref/source/makefile30
1 files changed, 30 insertions, 0 deletions
diff --git a/crawl-ref/source/makefile b/crawl-ref/source/makefile
index 97df81fb25..a3e059218f 100644
--- a/crawl-ref/source/makefile
+++ b/crawl-ref/source/makefile
@@ -6,6 +6,36 @@
# (if something breaks, blame him.)
#
+# Typical targets:
+# make
+# make wizard
+# make debug
+# make install
+# make wizard install
+# make debug install
+# -- note, unlike most programs, you need to specify build type when
+# installing even if you just built it.
+# Typical parameters:
+# TILES -- set to anything to enable tiles build
+#
+# CROSSHOST -- target system, eg, i386-pc-msdosdjgpp or i586-mingw32msvc
+#
+# prefix -- installation base. Specify eg. /usr/local on Unix systems.
+# DESTDIR -- installation staging area (the dir you intend to pack)
+# DATADIR -- place to hold immutable files. Can be either relative to
+# "prefix" or absolute.
+# SAVEDIR -- place to hold writeable data (saves, database, morgue
+# dumps). Can be relative to "prefix" or absolute.
+# Layout examples:
+# prefix=~/crawl DATADIR=data/ SAVEDIR=saves/
+# -- everything under ~/crawl
+# prefix=/usr/local
+# -- a typical multiuser installation
+#
+# V -- set to anything to enable verbose build
+#
+# USE_ICC -- set to use Intel's compiler
+
GAME = crawl
#