From: Richard Hartmann <richih.mailinglist@gmail.com>
Date: Fri, 3 Feb 2012 01:09:54 +0000 (+0100)
Subject: Fix documentation
X-Git-Url: https://git.madduck.net/code/vcsh.git/commitdiff_plain/f0e806b4189e61fec4a3dcd3164ed2a58e56bcce?hp=-c

Fix documentation

Thanks to Brian May for reporting this.

fix #22
---

f0e806b4189e61fec4a3dcd3164ed2a58e56bcce
diff --git a/README.md b/README.md
index bdc26bf..21c52cd 100644
--- a/README.md
+++ b/README.md
@@ -152,7 +152,7 @@ To illustrate further, the following steps could move your desired
 configuration to a new host.
 
 1. Clone the mr repository (containing available.d, config.d etc.); for
-   example: `vcsh clone git://github.com/RichiH/vcsh_mr_template.git`
+   example: `vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr`
 2. Choose your repositories by linking them in config.d (or go with the default
    you may have already configured by adding symlinks to git).
 3. Run mr to clone the repositories: `cd; mr update`.
@@ -201,7 +201,7 @@ the template will be stored.
     cd vcsh
     ln -s vcsh /usr/local/bin        # or add it to your PATH
     cd
-    vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr.vcsh
+    vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr
 
 #### 4.1.3 Enable Your Test Repository ####
 
@@ -236,7 +236,7 @@ Done!
 
 You're welcome to clone the example repository:
 
-    vcsh clone git://github.com/RichiH/vcsh_mr_template.git
+    vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr
 
 Look around in the clone. It should be reasonably simple to understand. If not,
 poke me, RichiH, on Freenode (query) or OFTC (#vcs-home).
diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn
index d68e886..f9a849f 100644
--- a/doc/vcsh.1.ronn
+++ b/doc/vcsh.1.ronn
@@ -48,7 +48,8 @@ The use of symlinks is not needed in this setup, making for a cleaner setup.
 vcsh. That being said, you can easily use `vcsh` without `mr` if you prefer.
 
 A sample configuration for `vcsh` and `mr` can be found at
-*https://github.com/RichiH/vcsh_mr_template*
+*https://github.com/RichiH/vcsh_mr_template* and used with `vcsh clone
+https://github.com/RichiH/vcsh_mr_template mr`.
 
 Please note that you can always use a path instead of a name for <repo>.
 This is needed to support mr and other scripts properly and of no concern to