Merge branch 'master' into docs

diff --combined README.md
index 7a2ba0413167e6ac4016a02f8b1ce4e213626153,73d096db8490c87759374a3a64d79f338ba61639..fce637b9d773a9d21900b7bb1589d52af9e14ae2
--- 1/README.md
--- 2/README.md
+++ b/README.md
@@@ -46,14 -46,14 +46,14 @@@ 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 ##
  
  To illustrate, this is what a possible directory structure looks like.
  
      $HOME
-         |-- .config
+         |-- $XDG_CONFIG_HOME (defaults to $HOME/.config)
          |   |-- mr
          |   |   |-- available.d
          |   |   |   |-- zsh.vcsh
@@@ -84,14 -84,16 +84,16 @@@
  
  ### available.d ###
  
- The files you see in ~/.config/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.
  
-     [$HOME/.config/vcsh/repo.d/zsh.git]
+     [$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
@@@ -100,7 -102,7 +102,7 @@@
  
  ### config.d ###
  
- ~/.config/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
@@@ -114,15 -116,16 +116,16 @@@ this
  
      [DEFAULT]
      jobs = 5
-     include = cat ~/.config/mr/config.d/*
+     include = cat $XDG_CONFIG_HOME/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).
- 
+ $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 +156,9 @@@ If you want to give vcsh a try, follow 
  
  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 ###
  
@@@ -166,10 -169,10 +169,10 @@@ Make sure none of the following files a
  
  * ~/.gitignore
  * ~/.mrconfig
- * ~/.config/mr/available.d/mr.vcsh
- * ~/.config/mr/available.d/zsh.vcsh
- * ~/.config/mr/config.d/mr.vcsh
- * ~/.config/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.
@@@ -190,7 -193,7 +193,7 @@@
  
      mv ~/.zsh   ~/zsh.bak
      mv ~/.zshrc ~/zshrc.bak
-     cd ~/.config/mr/config.d/
+     cd $XDG_CONFIG_HOME/mr/config.d/
      ln -s ../available.d/zsh.vcsh .  # link, and thereby enable, the zsh repository
      cd
      mr up
@@@ -199,8 -202,8 +202,8 @@@
  
  Now, it's time to edit the template config and fill it with your own remotes:
  
-     vim .config/mr/available.d/mr.vcsh
-     vim .config/mr/available.d/zsh.vcsh
+     vim $XDG_CONFIG_HOME/mr/available.d/mr.vcsh
+     vim $XDG_CONFIG_HOME/mr/available.d/zsh.vcsh
  
  And then create your own stuff:
  
@@@ -210,8 -213,8 +213,8 @@@
      vcsh run foo git commit
      vcsh run foo git push
  
-     cp .config/mr/available.d/mr.vcsh .config/mr/available.d/foo.vcsh
-     vim .config/mr/available.d/foo.vcsh # add your own repo
+     cp $XDG_CONFIG_HOME/mr/available.d/mr.vcsh $XDG_CONFIG_HOME/mr/available.d/foo.vcsh
+     vim $XDG_CONFIG_HOME/mr/available.d/foo.vcsh # add your own repo
  
  Done!
  
@@@ -242,7 -245,7 +245,7 @@@ copy mine verbatim, either is fine
  Grab my mr config. see below for details on how I set this up
  
      vcsh clone ssh://<remote>/mr.git
-     cd ~/.config/mr/config.d/
+     cd $XDG_CONFIG_HOME/mr/config.d/
      ln -s ../available.d/* .
  
  
@@@ -250,7 -253,7 +253,7 @@@ mr is used to actually retrieve configs
  
      ~ % cat ~/.mrconfig
      [DEFAULT]
-     include = cat ~/.config/mr/config.d/*
+     include = cat $XDG_CONFIG_HOME/mr/config.d/*
      ~ % echo $XDG_CONFIG_HOME
      /home/richih/.config
      ~ % ls $XDG_CONFIG_HOME/mr/available.d # random selection of my repos
@@@ -287,7 -290,7 +290,7 @@@ git-status. A fix for this problem is b
  
  ### 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.