X-Git-Url: https://scripts.mit.edu/gitweb/www/ikiwiki.git/blobdiff_plain/4359f337e3590116b7ffc22ffeace60bc330411e..af3cc556bab1e2b840f8521b4da09bcf05f04fd9:/README
diff --git a/README b/README
index d4be0455a..a4dc0d641 100644
--- a/README
+++ b/README
@@ -1,16 +1,23 @@
Use ./Makefile.PL to generate a Makefile, "make" will build the
documentation wiki and a man page, and "make install" will install ikiwiki.
+All other documentation is in the ikiwiki documentation wiki, which is also
+available online at
+
+
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
+ PROFILE=1 turns on profiling for the build of the doc wiki.
+ (Uses Devel::NYTProf)
-NOTAINT=0 turns on the taint flag in the ikiwiki program. (Not recommended
-unless your perl is less buggy than mine -- see
-http://bugs.debian.org/411786)
+ NOTAINT=0 turns on the taint flag in the ikiwiki program. (Not recommended
+ unless your perl is less buggy than mine -- see
+ http://bugs.debian.org/411786)
-There are also other variables supported by MakeMaker, including PREFIX,
-INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3).
+ There are also other variables supported by MakeMaker, including PREFIX,
+ INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3).
-All other documentation is in the ikiwiki documentation wiki, which is also
-available online at
+ In particular, INSTALL_BASE is very useful if you want to install ikiwiki
+ to some other location, as it configures it to see the perl libraries
+ there. See `doc/tips/nearlyfreespeech.mdwn` for an example of using this to
+ install ikiwiki and its dependencies in a home directory.