web commit by JonasSmedegaard: Mention location of apt-get'able HTML::WikiConverter...

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index d908e217788b96d175550e0398fe5324b5b3c4b6..13f8500c42c81cfb2dd7661f072d5cb54d3b9fd3 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -121,39 +121,42 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    [[toggleable id=git text="""
        When using Git, you probably want to set up two repositories, of which
        one should be bare (meaning that it does not have a working tree
-       checked out). We call the bare repository the "repo" and the other the
-       "srcdir". There are [other
+       checked out). We call the bare repository the "repository" and the
+       other will be the "srcdir" (which `ikiwiki` uses to compile the wiki).
+       There are [other
        ways](http://blog.madduck.net/vcs/2007.07.11_publishing-git-repositories)
        to do the following, but this might be easiest:
 
-                       REPO=~/wiki.git
+                       REPOSITORY=~/wiki.git
                        cd $SRCDIR
                        git init
-                       echo .ikiwiki > .gitignore
+                       echo /.ikiwiki > .gitignore
                        git add .
                        git commit -m'Initial commit'
-                       # if you expect $REPO to receive pushs from multiple
-                       # clones, then it is advisable to stop git performing
-                       # fast forwards -- this is to avoid overwriting the
-                       # remote ref and losing commits from there.
+                       # if you expect $REPOSITORY to receive pushs from multiple
+                       # clones, then it is advisable to only accept fast
+                       # forwards -- this is to avoid overwriting the remote
+                       # ref and losing commits from there.
                        git config receive.denyNonFastForwards true
                        git config core.bare true
-                       mv .git $REPO
-                       mv .ikiwiki ..
+                       mv .git $REPOSITORY
+                       # we want to preserve the current .ikiwiki directory,
+                       # so temporarily move it to a safe location
+                       mv .ikiwiki ../ikiwiki.sv
                        cd ..
                        rm -r $SRCDIR
-                       git clone -l -s $REPO $SRCDIR
-                       mv .ikiwiki $SRCDIR
+                       git clone -l -s $REPOSITORY $SRCDIR
+                       mv ikiwiki.sv $SRCDIR/.ikiwiki
 
        It is **paramount** that you **never** push to the Git repository in
        `$SRCDIR` ([this FAQ entry explains
        why](http://git.or.cz/gitwiki/GitFaq#head-b6a3d85f677763313159eb39f7dbf4579d4ee28b)).
        Instead, if you want to work on the wiki from a remote machine, clone
-       `$REPO`, using either the `git` transport (if available), or
+       `$REPOSITORY`, using either the `git` transport (if available), or
        `ssh`.
 
        If at any point you commit changes in `$SRCDIR`, make sure to `git
-       push` them to the `$REPO`.
+       push` them to the `$REPOSITORY`.
    """]]
 
    [[toggle id=tla text="TLA"]]