X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/0751429ba0cb4cf9a8c132daf54e7dc8dca36df6..19945b53581a693ee4c4b32671313dea59c83f53:/README diff --git a/README b/README index e9ee15dfe..d4be0455a 100644 --- a/README +++ b/README @@ -1,4 +1,16 @@ -Use ./Makefile.PL to generate a Makefile, "make" will generate docs and a -man page, and "make install" will install ikiwiki. +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. +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). + +All other documentation is in the ikiwiki documentation wiki, which is also +available online at