X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=README;h=fdb63227d02e7f26f778e38b327c62413cce9b88;hb=f44135c66b716433eb94f57a16bcc7ad1a893fea;hp=f5b128d8a51984e15ebc300856cffd1295e2aa04;hpb=a4b4a614bea0d7b8e30702ad63b7cae3ef44524e;p=ikiwiki.git diff --git a/README b/README index f5b128d8a..fdb63227d 100644 --- a/README +++ b/README @@ -1,5 +1,21 @@ 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=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). + +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. + All other documentation is in the ikiwiki documentation wiki, which is also -available online at +available online at