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