]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/install.mdwn
* Allow preprocessor directives to contain python-like triple-quoted
[ikiwiki.git] / doc / install.mdwn
index e8c94361cfc8792489a38a4b632e9d24aed72f53..9164d71858731e4a7b2f75f93b9f5cd098cffaaa 100644 (file)
@@ -1,9 +1,24 @@
 The easiest way to install ikiwiki is using the Debian package.
 
-If you want to install from the tarball, you should make sure that the required perl modules are installed, then run:
+Ikiwiki is a perl program, and needs a recent version of perl such as
+5.8.8. (5.8.0 has been reported not to work).
+
+Ikiwiki requires [[MarkDown]] and the `HTML::Parser` perl module be
+installed, and also uses the following perl modules if available: 
+`CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer)
+`HTML::Template` `Mail::SendMail` `Time::Duration` `Date::Parse`,
+`HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`
+
+If you're installing MarkDown by hand, note that it should be installed as
+`Markdown.pm` somewhere in perl's module search path, or alternately as
+`/usr/bin/markdown`. Ikiwiki will find it under either name.
+
+If you want to install from the tarball, you should make sure that the
+required perl modules are installed, then run:
 
         perl Makefile.PL
         make
+       make test # optional
         make install
 
-See [[download]] for where to get it.
\ No newline at end of file
+See [[download]] for where to get it.