X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/4359f337e3590116b7ffc22ffeace60bc330411e..b69c3a9f7f1b6cffa90f493ed0b5129ed0981087:/README?ds=sidebyside

diff --git a/README b/README
index d4be0455a..611b9a45b 100644
--- a/README
+++ b/README
@@ -1,16 +1,27 @@
 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:
+All other documentation is in the ikiwiki documentation wiki, which is also
+available online at <http://ikiwiki.info/>
 
-PROFILE=1 turns on profiling for the build of the doc wiki. Uses Devel::Profile
 
-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)
+A few special variables you can set while using the Makefile.PL:
 
-There are also other variables supported by MakeMaker, including PREFIX,
-INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3).
+  PROFILE=1 turns on profiling for the build of the doc wiki.
+  (Uses Devel::NYTProf)
 
-All other documentation is in the ikiwiki documentation wiki, which is also
-available online at <http://ikiwiki.info/>
+  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)
+
+  MAKE, FIND, and SED can be used to specify where you have the GNU
+  versions of those tools installed, if the normal make, find, and sed
+  are not GNU.
+
+  There are also other variables supported by MakeMaker, including PREFIX,
+  INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3).
+
+  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.