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