add

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index e9c690f4558961ebd5e061a96337fb9140f7c601..7e4aaecf9465cab258b8827365c04a17e52a7c21 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,14 +1,8 @@
-So you want to set up your own wiki using ikiwiki? This turorial will walk
+So you want to set up your own wiki using ikiwiki? This tutorial will walk

 you through setting up a wiki that is stored in [[Subversion]] and that has
 optional support for commits from the web.
 
 you through setting up a wiki that is stored in [[Subversion]] and that has
 optional support for commits from the web.
 

-1. [[Install]] ikiwiki.
-
-               apt-get install ikiwiki # soon
-
-   Ikiwiki requires [[MarkDown]] be installed, and also uses the following
-   perl modules: `CGI::Session` `CGI::FormBuilder` `HTML::Template`
-   `Mail::SendMail` `Time::Duration`
+1. [[Install]] ikiwiki. See [[download]] for where to get it.

 
 2. Create the subversion repository for your wiki.
 
 
 2. Create the subversion repository for your wiki.
 


@@ -19,22 +13,24 @@ optional support for commits from the web.
 
                svn co file:///svn/wikirepo/trunk ~/wikiwc
 
 
                svn co file:///svn/wikirepo/trunk ~/wikiwc
 

-4. Create some files and add them into subversion. Or you might copy the
-   files from /usr/share/ikiwiki/basewiki and check those in to get a
-   head start on creating your wiki.
-
-               echo "Welcome to my empty wiki." > ~/wikiwc/index.mdwn
-               echo "Feel free to edit this page" > ~/wikiwc/sandbox.mdwn
-               svn add ~/wikiwc/*.mdwn
-               svn commit ~/wikiwc -m add
-
-5. Build your wiki for the first time.
+4. Build your wiki for the first time.

 
                ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
                        --url=http://host/~you/wiki/
 
    Replace the url with the real url to your wiki. You should now
 
                ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
                        --url=http://host/~you/wiki/
 
    Replace the url with the real url to your wiki. You should now

-   be able to visit the url and see your page that you created earlier.
+   be able to visit the url and see your wiki.
+
+5. Customise your wiki. The files in `/usr/share/ikiwiki/basewiki/` are
+   used if you don't have a custom version, so let's start by making a
+   custom version of the wiki's index page:
+
+               cp /usr/share/ikiwiki/basewiki/index.mdwn ~/wikiwc
+               svn add ~/wikiwc/index.mdwn
+               $EDITOR ~/wikiwc/index.mdwn
+               svn commit ~/wikiwc/index.mdwn -m customised
+
+   You can also add any files you like from scratch of course.

 
 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
    the wiki. You can play around with other ikiwiki parameters such as
 
 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
    the wiki. You can play around with other ikiwiki parameters such as