X-Git-Url: http://git.tremily.us/?p=ikiwiki.git;a=blobdiff_plain;f=README;h=611b9a45bf8188d6bf5e3bb48ac9745d67322a37;hp=488ef7191596253107cc6e63814c4b313d4fb2fd;hb=4cb343f3482edc3786ea46eea7efb7762d349164;hpb=d14bde197eb0704c4172ad7113cc9c739487e724 diff --git a/README b/README index 488ef7191..611b9a45b 100644 --- a/README +++ b/README @@ -1,13 +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 -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: -All other documentation is in the ikiwiki documentation wiki, which is also -available online at + 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) + + 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.