updated branch; this is ready for review for inclusion in IkIWiki

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

diff --git a/doc/install.mdwn b/doc/install.mdwn
index cc3a4c29f186ca1d0c952c28b14733dda70d0659..48c11272b0e0ba9fdae6dff7f68a093c4e2212a7 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -11,9 +11,11 @@ Ikiwiki is a perl program, and needs a recent version of perl such as
 It's recommended you have a C compiler, as ikiwiki uses one to build
 wrappers.
 
 It's recommended you have a C compiler, as ikiwiki uses one to build
 wrappers.
 

-Ikiwiki requires the [[!cpan Text::Markdown]], [[!cpan URI]],
-[[!cpan HTML::Parser]], [[!cpan HTML::Template]], and [[!cpan HTML::Scrubber]]
-perl modules be installed. It can also use a lot of other perl modules, if
+Ikiwiki requires the [[!cpan Text::Markdown::Discount]] (or 
+[[!cpan Text::Markdown]]), [[!cpan URI]],
+[[!cpan HTML::Parser]], [[!cpan HTML::Template]], [[!cpan YAML::XS]] and [[!cpan HTML::Scrubber]]
+perl modules be installed. 
+It can also use a lot of other perl modules, if

 they are available.
 
 Various [[plugins]] use other perl modules and utilities; see their individual
 they are available.
 
 Various [[plugins]] use other perl modules and utilities; see their individual


@@ -23,7 +25,7 @@ documentation for details.
 
 If you want to install by hand from the tarball, you should make sure that
 all the perl modules are installed. This is one way to install them, using
 
 If you want to install by hand from the tarball, you should make sure that
 all the perl modules are installed. This is one way to install them, using

-CPAN:
+CPAN to install modules from your local machine after you extract the ikiwiki tarball:

 
        PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
        PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki::Extras")'
 
        PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
        PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki::Extras")'


@@ -32,7 +34,7 @@ CPAN:
 
 Then to build and install ikiwiki:
 
 
 Then to build and install ikiwiki:
 

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

        make
        make test # optional
        make install
        make
        make test # optional
        make install


@@ -41,5 +43,6 @@ If you're using a shared hosting provider, of the sort where you don't have
 root, you can still install ikiwiki. There are tutorials covering this for
 a few providers:
 
 root, you can still install ikiwiki. There are tutorials covering this for
 a few providers:
 

+

 * [[tips/NearlyFreeSpeech]]
 * [[tips/DreamHost]]
 * [[tips/NearlyFreeSpeech]]
 * [[tips/DreamHost]]