web commit by http://getopenid.com/ptecza: Bug report

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 383cdca9d5cc93bfb0dc601728dc5f33dc74e35c..41c42a723be161810d7cbfb381722f6ba1386311 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -46,9 +46,15 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    be able to visit the url and see your wiki.
 
 5. Repeat steps 3 and 4 as desired, editing or adding pages and rebuilding
-   the wiki. You can play around with other ikiwiki parameters such as
-   `--wikiname` and `--rebuild` too. Get comfortable with its command line
-   (see [[usage]]).
+   the wiki. 
+   
+   To quickly get started on a common task like blogging with ikiwiki, you
+   can copy in files from the [[examples]]. The examples are located in
+   `doc/examples/` in the ikiwiki source package.
+
+   You can play around with other ikiwiki parameters such as `--wikiname`
+   and `--rebuild` too. Get comfortable with its command line (see
+   [[usage]]).
 
 6. By now you should be getting tired of typing in all the command line
    options each time you change something in your wiki's setup. Time to
@@ -89,15 +95,19 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    
    There's little that's ikiwiki specific about these instructions; this is
    just how you put a directory under revision control using the various
-   systems that ikiwiki supports.
+   systems that ikiwiki supports. Note that the .ikiwiki subdirectory is
+   where ikiwiki keeps its state, and should be preserved, but not checked
+   into revision control.
 
    [[toggle id=subversion text="Subversion"]]
    [[toggleable id=subversion text="""
                        REPOSITORY=~/wikirepo
                        svnadmin create $REPOSITORY
-                       svn import $SRCDIR file://$REPOSITORY/trunk -m "initial import"
-                       rm -rf $SRCDIR
-                       svn co file://$REPOSITORY/trunk $SRCDIR
+                       svn mkdir file://$REPOSITORY/trunk -m "create trunk"
+                       cd $SRCDIR
+                       svn co file://$REPOSITORY/trunk .
+                       svn add *
+                       svn commit -m "initial import"
    """]]
    
    [[toggle id=git text="Git"]]
@@ -109,6 +119,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
                        cp -a $SRCDIR/* .
                        git add .
                        git commit -m "initial import" -a
+                       mv $SRCDIR/.ikiwiki .
                        rm -rf $SRCDIR
                        git clone -l -s $REPOSITORY $SRCDIR
    """]]
@@ -131,6 +142,9 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    [[toggleable id=mercurial text="""
                        REPOSITORY=$SRCDIR
                        hg init $REPOSITORY
+                       cd $REPOSITORY
+                       hg add *
+                       hg commit -m "initial import"
    """]]
 
 9. Configure ikiwiki to use revision control.