document special variables for Makefile
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Tue, 10 Apr 2007 01:25:16 +0000 (01:25 +0000)
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Tue, 10 Apr 2007 01:25:16 +0000 (01:25 +0000)
README

diff --git a/README b/README
index f8dfc39..b7b99c0 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,10 @@
 Use ./Makefile.PL to generate a Makefile, "make" will build the
 documentation wiki and a man page, and "make install" will install ikiwiki.
 
+A few special variables you can set while using the Makefile:
+
+PROFILE=1 turns on profiling for the build of the doc wiki. Uses Devel::Profile
+NOTAINT=1 turns off the taint flag in the ikiwiki program
+
 All other documentation is in the ikiwiki documentation wiki, which is also
 available online at <http://ikiwiki.info/>