move template documentation to the template directive
[ikiwiki] / README
1 Use ./Makefile.PL to generate a Makefile, "make" will build the
2 documentation wiki and a man page, and "make install" will install ikiwiki.
3
4 All other documentation is in the ikiwiki documentation wiki, which is also
5 available online at <http://ikiwiki.info/>
6
7
8 A few special variables you can set while using the Makefile.PL:
9
10   PROFILE=1 turns on profiling for the build of the doc wiki.
11   (Uses Devel::NYTProf)
12
13   NOTAINT=0 turns on the taint flag in the ikiwiki program. (Not recommended
14   unless your perl is less buggy than mine -- see
15   http://bugs.debian.org/411786)
16
17   There are also other variables supported by MakeMaker, including PREFIX,
18   INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3).
19
20   In particular, INSTALL_BASE is very useful if you want to install ikiwiki
21   to some other location, as it configures it to see the perl libraries
22   there. See `doc/tips/nearlyfreespeech.mdwn` for an example of using this to
23   install ikiwiki and its dependencies in a home directory.