Some README fixes

[code/vcsh.git] / README.md

diff --git a/README.md b/README.md
index 6c59618b139efe2bb7909ae658bc3afb89b58ae5..7a2ba0413167e6ac4016a02f8b1ce4e213626153 100644 (file)
--- a/README.md
+++ b/README.md
@@ -46,7 +46,7 @@ the **actual files right into $HOME**.
 
 Furthermore, by making use of [mr] [1], it makes it very easy to enable/disable
 and clone a large number of repositories. The use of mr is technically optional
-(see 3.4), but it will be an integral part of the proposed system that follows.
+(see 4.3), but it will be an integral part of the proposed system that follows.
 
 ## 2.2 Default Directory Layout ##
 
@@ -92,11 +92,11 @@ access to my zshrc repo looks likes. I.e. in this specific example, push can
 not work.
 
     [$HOME/.config/vcsh/repo.d/zsh.git]
-    checkout = vcsh clone 'git://github.com/RichiH/zshrc.git'
-    update   = vcsh run bash git pull
-    push     = vcsh run bash git push
-    status   = vcsh run bash git status
-    gc       = vcsh run bash git gc
+    checkout = vcsh clone 'git://github.com/RichiH/zshrc.git' zsh
+    update   = vcsh run zsh git pull
+    push     = vcsh run zsh git push
+    status   = vcsh run zsh git status
+    gc       = vcsh run zsh git gc
 
 ### config.d ###
 
@@ -106,13 +106,6 @@ that in this example, only the zsh, gitconfigs, tmux and vim repositories will
 be checked out. A simple `mr update` run in $HOME will clone or update those
 four repositories listed in config.d.
 
-### repo.d ###
-
-~/.config/vcsh/repo.d is the directory into which vcsh clones the git
-repositories. Since their working trees are configured to be in $HOME, the
-files contained in those repositories will be put in $HOME directly (see .zshrc
-above).
-
 ### ~/.mrconfig ###
 
 Finally, ~/.mrconfig will tie together all those single files which will allow
@@ -123,6 +116,13 @@ this:
     jobs = 5
     include = cat ~/.config/mr/config.d/*
 
+### repo.d ###
+
+~/.config/vcsh/repo.d is the directory into which vcsh clones the git
+repositories. Since their working trees are configured to be in $HOME, the
+files contained in those repositories will be put in $HOME directly (see .zshrc
+above).
+
 
 vcsh will check if any file it would want to create exists. If it exists, vcsh
 will throw a warning and exit. Move away your old config and try again.
@@ -174,7 +174,7 @@ Make sure none of the following files and directories exist for your test
 All of the files are part of the template repository, the directory is where
 the template will be stored.
 
-    apt-get install mr               # this is optional, but highly recommended
+    apt-get install mr
 
 #### 3.1.2 Clone the Template ####
 
@@ -287,7 +287,7 @@ git-status. A fix for this problem is being worked on.
 
 ### 4.3 Using vcsh without mr ###
 
-vcsh encourages you to use mr. It helps you manage a large number of
+vcsh encourages you to use [mr] [1]. It helps you manage a large number of
 repositories by running the necessary vcsh commands for you. You may choose not
 to use mr, in which case you will have to run those commands manually or by
 other means.