vcsh plugin needs only be included up until mr 1.10

[code/vcsh.git] / README.md

diff --git a/README.md b/README.md
index 66db1106b82582cc3e0b4bf50b97ddbb1a551c35..8017d843406030f4220b39326bdf71b17c5a4e40 100644 (file)
--- a/README.md
+++ b/README.md
@@ -113,11 +113,14 @@ 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
-    update   = vcsh run zsh git pull
-    push     = vcsh run zsh git push
-    status   = vcsh run zsh git status
-    gc       = vcsh run zsh git gc
+    checkout = vcsh clone 'git://github.com/RichiH/zshrc.git' $MR_REPO
+    push     = echo "Cannot push to read-only repo" >&2
+    #status   = vcsh run $MR_REPO git $MR_ACTION
+    #commit   = vcsh run $MR_REPO git $MR_ACTION
+    #gc       = vcsh run $MR_REPO git $MR_ACTION
+
+The commented lines are only necessary if you are using `mr` prior to version
+1.11. Starting with this version, `vcsh` support is properly integrated.
 
 ### config.d ###
 
@@ -135,8 +138,11 @@ this:
 
     [DEFAULT]
     jobs = 5
-    # Use if your mr does not have vcsh support in mainline, yet
+    # The following line is only needed if your mr does not have vcsh support
+    # in core, that is version 1.10 or older. Check the file itself if you are
+    # unsure.
     include = cat /usr/share/mr/vcsh
+    # Include all (enabled) configuration snippets (see above)
     include = cat ${XDG_CONFIG_HOME:-$HOME/.config}/mr/config.d/*
 
 ### repo.d ###
@@ -163,7 +169,7 @@ configuration to a new host.
 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. Make sure the line 'include = cat /usr/share/mr/vcsh' in .mrconfig points
-   to an existing file
+   to an existing file. Check the file itself to see if the line is necessary.
 4. Run mr to clone the repositories: `cd; mr update`.
 5. Done.