]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/install.mdwn
web commit by EdAvis
[ikiwiki.git] / doc / install.mdwn
index 0aa55fb0b7e9204cc35e547bcc90c53077b3cc3a..3a9885828ee7d8acf427f7ba4461fdd8a7959187 100644 (file)
@@ -1,14 +1,24 @@
 The easiest way to install ikiwiki is using the Debian package.
 
-Ikiwiki requires [[MarkDown]] 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` (libtimedate-perl), `HTML::Scrubber`, `RPC::XML`
+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).
 
-If you want to install from the tarball, you should make sure that the required perl modules are installed, then run:
+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`.  The 'fortune' plugin uses fortune(1).
+
+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.