web commit by http://chrisisbd.myopenid.com/

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

diff --git a/doc/install.mdwn b/doc/install.mdwn
index f65e1a227fd642d21b9473e7f6eafd8b8452ced4..b01fcdf6bc6a14ef7532a94cffd8558e4b74064b 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,15 +1,29 @@
-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 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`,
-`XML::Simple`
+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]] and
+[[cpan HTML::Parser]] 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 HTML::Template]], [[cpan Mail::Sendmail]], [[cpan Time::Duration]]
+[[cpan TimeDate]], [[cpan HTML::Scrubber]], [[cpan RPC::XML]],
+[[cpan XML::Simple]], [[cpan XML::Feed]], [[cpan File::MimeInfo]].

 
 

-        perl Makefile.PL
-        make
-        make install
+The [[tla]] support also needs the [[cpan MailTools]] perl module.
+
+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.
 
 See [[download]] for where to get it.