Update changelog, release v0.20120227

[code/vcsh.git] / README.md

diff --git a/README.md b/README.md
index f30545d1ebfd8b10c3bec43325bdb3bba0e0136e..c0585d237617259e167c1ca5670d5d4c831a9bc8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ community around the general idea of version controlling your (digital) life.
 
 * IRC: #vcs-home on irc.oftc.net
 
 
 * IRC: #vcs-home on irc.oftc.net
 

-* Mailing list: vcs-home@lists.madduck.net
+* Mailing list: http://lists.madduck.net/listinfo/vcs-home

 
 * Pull requests or issues on https://github.com/RichiH/vcsh
 
 
 * Pull requests or issues on https://github.com/RichiH/vcsh
 


@@ -98,7 +98,7 @@ To illustrate, this is what a possible directory structure looks like.
 
 ### available.d ###
 
 
 ### available.d ###
 

-The files you see in $XDG_CONFIG_HOME/mr/available.d are mr configuration files
+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
 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


@@ -116,7 +116,7 @@ this repository and fork your own.
 
 ### config.d ###
 
 
 ### config.d ###
 

-$XDG_CONFIG_HOME/mr/available.d contains *all available* repositories. Only
+$XDG\_CONFIG\_HOME/mr/available.d contains *all available* repositories. Only

 files/links present in mr/config.d, however, will be used by mr. That means
 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
 files/links present in mr/config.d, however, will be used by mr. That means
 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


@@ -130,11 +130,13 @@ this:
 
     [DEFAULT]
     jobs = 5
 
     [DEFAULT]
     jobs = 5

-    include = cat $XDG_CONFIG_HOME/mr/config.d/*
+    # Use if your mr does not have vcsh support in mainline, yet
+    include = cat /usr/share/mr/vcsh
+    include = cat ${XDG_CONFIG_HOME:-$HOME/.config}/mr/config.d/*

 
 ### repo.d ###
 
 
 ### repo.d ###
 

-$XDG_CONFIG_HOME/vcsh/repo.d is the directory where all git repositories which
+$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.
 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.


@@ -185,10 +187,10 @@ Make sure none of the following files and directories exist for your test
 
 * ~/.gitignore.d
 * ~/.mrconfig
 
 * ~/.gitignore.d
 * ~/.mrconfig

-* $XDG_CONFIG_HOME/mr/available.d/mr.vcsh
-* $XDG_CONFIG_HOME/mr/available.d/zsh.vcsh
-* $XDG_CONFIG_HOME/mr/config.d/mr.vcsh
-* $XDG_CONFIG_HOME/vcsh/repo.d/mr.git/
+* $XDG\_CONFIG\_HOME/mr/available.d/mr.vcsh
+* $XDG\_CONFIG\_HOME/mr/available.d/zsh.vcsh
+* $XDG\_CONFIG\_HOME/mr/config.d/mr.vcsh
+* $XDG\_CONFIG\_HOME/vcsh/repo.d/mr.git/

 
 All of the files are part of the template repository, the directory is where
 the template will be stored.
 
 All of the files are part of the template repository, the directory is where
 the template will be stored.