suggest running make test as part of install
[ikiwiki] / doc / install.mdwn
1 The easiest way to install ikiwiki is using the Debian package.
2
3 Ikiwiki requires [[MarkDown]] and the `HTML::Parser` perl module be
4 installed, and also uses the following perl modules if available: 
5 `CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer)
6 `HTML::Template` `Mail::SendMail` `Time::Duration` `Date::Parse`,
7 `HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`
8
9 If you're installing MarkDown by hand, note that it should be installed as
10 `Markdown.pm` somewhere in perl's module search path, or alternately as
11 `/usr/bin/markdown`. Ikiwiki will find it under either name.
12
13 If you want to install from the tarball, you should make sure that the
14 required perl modules are installed, then run:
15
16         perl Makefile.PL
17         make
18         make test # optional
19         make install
20
21 See [[download]] for where to get it.