Forgot to commit manpage for `vcsh <repo>`

[code/vcsh.git] / README.md

diff --git a/README.md b/README.md
index 04834386240b65e00d84a0c5b7dae1170b900ace..fce637b9d773a9d21900b7bb1589d52af9e14ae2 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 ##
 
@@ -84,12 +84,14 @@ To illustrate, this is what a possible directory structure looks like.
 
 ### available.d ###
 
-The files you see in $XDG_CONFIG_HOME/mr/available.d are mr configuration files that
-contain the commands to manage (checkout, update etc.) a single repository.
-vcsh repo configs end in .vcsh, git configs end in .git, etc. This is optional
-and your preference. For example, this is what a zsh.mrconfig with read-only
-access to my zshrc repo looks likes. I.e. in this specific example, push can
-not work.
+The files you see in $XDG_CONFIG_HOME/mr/available.d are mr configuration files
+that contain the commands to manage (checkout, update etc.) a single
+repository. vcsh repo configs end in .vcsh, git configs end in .git, etc. This
+is optional and your preference. For example, this is what a zsh.vcsh
+with read-only access to my zshrc repo looks likes. I.e. in this specific
+example, push can not work as you will be using the author's repository. This
+is for demonstration, only. Of course, you are more than welcome to clone from
+this repository and fork your own.
 
     [$XDG_CONFIG_HOME/vcsh/repo.d/zsh.git]
     checkout = vcsh clone 'git://github.com/RichiH/zshrc.git' zsh
@@ -118,11 +120,12 @@ this:
 
 ### repo.d ###
 
-$XDG_CONFIG_HOME/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).
-
+$XDG_CONFIG_HOME/vcsh/repo.d is the directory where all git repositories which
+are under vcsh's control are located. Since their working trees are configured
+to be in $HOME, the files contained in those repositories will be put in $HOME
+directly.
+Of course, [mr] [1] will work with this layout if configured according to this
+document (see 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.
@@ -153,9 +156,9 @@ If you want to give vcsh a try, follow the instructions below.
 
 Below, you will find a few different methods for setting up vcsh:
 
-3.1. The Template Way
-3.2. The Steal-from-Template Way
-3.3. The Manual Way
+1. The Template Way
+2. The Steal-from-Template Way
+3. The Manual Way
 
 ### 3.1 The Template Way ###
 
@@ -287,7 +290,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.