web commit by JoshTriplett: Wrong report category. Also, example of problem on ...

[ikiwiki.git] / doc / install.mdwn

diff --git a/doc/install.mdwn b/doc/install.mdwn
index 003da0ec712e7aafd074378411187c2d2f018c8e..da84616e4d0a3802fc9765f1ec47bc67ae71d62e 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,14 +1,30 @@
-The easiest way to install ikiwiki is using the Debian package.
+The easiest way to install ikiwiki is using the Debian package, but you can
+also [[download]] the source and install it by hand. Ikiwiki should work on
+most unix-like systems.
 
-Ikiwiki requires [[MarkDown]] be installed, and also uses the following
-perl modules: `CGI::Session` `CGI::FormBuilder` (version 3.02.02 or
-newer) `HTML::Template` `Mail::SendMail` `Time::Duration` `Date::Parse`
-(libtimedate-perl), `HTML::Scrubber`
+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 the [[cpan Text::Markdown]], [[cpan URI]],
+[[cpan HTML::Parser]], and [[cpan HTML::Template]] perl modules be
+installed, and also uses the following perl modules if available: 
+[[cpan CGI::Session]], [[cpan CGI::FormBuilder]] (version 3.02.02 or newer),
+[[cpan Mail::Sendmail]], [[cpan Time::Duration]], [[cpan TimeDate]],
+[[cpan HTML::Scrubber]], [[cpan RPC::XML]], [[cpan XML::Simple]],
+[[cpan XML::Feed]], [[cpan File::MimeInfo]], [[cpan Locale::gettext]]
+(version 1.04 or newer).
 
-        perl Makefile.PL
-        make
-        make install
+The [[tla]] support also needs the [[cpan MailTools]] perl module.
 
-See [[download]] for where to get it.
\ No newline at end of file
+Various [[plugins]] use other libraries and utlities; see their individual
+documentation for details.
+
+If you want to install from the tarball, you should make sure that the
+required perl modules are installed, then run:
+
+       perl Makefile.PL # PREFIX=/dir to install elsewhere
+       make
+       make test # optional
+       make install
+
+See [[download]] for where to get it.