X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=README;h=408ab666abad8599b95b831f09cde24c693e9ab6;hb=f1a70921e3bfc0496b5564582a5a1463b7a98c09;hp=ba632a300399d4a58c1242435f17a447a35ef914;hpb=9589b7a83c943891dfbaaea38781b2cb4366cc4f;p=ikiwiki.git
diff --git a/README b/README
index ba632a300..408ab666a 100644
--- a/README
+++ b/README
@@ -1,13 +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::Profile)
-NOTAINT=1 turns off the taint flag in the ikiwiki program. (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)
-All other documentation is in the ikiwiki documentation wiki, which is also
-available online at
+ 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.