done-ish

[git.ikiwiki.info.git] / doc / install.mdwn

diff --git a/doc/install.mdwn b/doc/install.mdwn
index 49153c0d0067270beb10784ca94f4b7756d75ae9..bc10677376e00551b4e277adfc47dd0a8da578d8 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,10 +1,21 @@
-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]] and the `HTML::Parser` perl module be
-installed, and also uses the following perl modules if available: 
+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 `URI` and `HTML::Parser` perl
+modules be installed, and also uses the following perl modules if
+available: 

 `CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer)
 `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`
+`HTML::Template` `Mail::Sendmail` `Time::Duration` `Date::Parse`,
+`HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`.
+
+The [[tla]] support also needs the `MailTools` perl module.
+
+Various [[plugins]] use other libraries and utlities; see their individual
+documentation for details.

 
 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
 
 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


@@ -13,8 +24,9 @@ If you're installing MarkDown by hand, note that it should be installed as
 If you want to install from the tarball, you should make sure that the
 required perl modules are installed, then run:
 
 If you want to install from the tarball, you should make sure that the
 required perl modules are installed, then run:
 

-        perl Makefile.PL
+        perl Makefile.PL # PREFIX=/dir to install elsewhere

         make
         make

+       make test # optional

         make install
 
 See [[download]] for where to get it.
         make install
 
 See [[download]] for where to get it.