]> git.madduck.net Git - code/vcsh.git/blobdiff - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

More work on README.md
[code/vcsh.git] / README.md
index f73674107894870e51f8669f8d05e6a9836eb211..f13a959fc34e62e9fcd1e04086118c3ff0de3690 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,30 +15,39 @@ community around the general idea of version controlling your (digital) life.
 
 * IRC: #vcs-home on irc.oftc.net
 
-* Mailing list: http://lists.madduck.net/listinfo/vcs-home
+* Mailing list: [http://lists.madduck.net/listinfo/vcs-home][vcs-home-list]
 
-* Pull requests or issues on https://github.com/RichiH/vcsh
+* Pull requests or issues on [https://github.com/RichiH/vcsh][vcsh]
 
 # 2 Introduction #
 
-vcsh allows you to have several git repositories, all maintaining their working
-trees in $HOME without clobbering each other. That, in turn, means you can have
-one repository per config set (zsh, vim, ssh, etc), picking and choosing which
-configs you want to use on which machine.
-
-vcsh was designed with [mr] [1] in mind so you might want to install that, as
+[vcsh][vcsh] allows you to maintain several git repositories in one single
+directory. They all maintain their working trees without clobbering each other
+or interfering otherwise. By default, all git repositories maintained via
+`vcsh` are stored in `$HOME` but you can override this setting if you want to.
+All that means that you can have one repository per application or application
+family, i.e. `zsh`, `vim`, `ssh`, etc. This, in turn, allows you to clone
+custom sets of configurations onto different machines or even for different
+users; picking and mixing which configurations you want to use where.
+For example, you may not need to have your `mplayer` configuration on a server
+or available to root and you may want to maintain different configuration for
+`ssh` on your personal and your work machines.
+
+`vcsh` was designed with [mr][mr] in mind so you might want to install that, as
 well.
 
-Read INSTALL.md for detailed setup instructions.
+Read `INSTALL.md` and `PACKAGING` for instructions specific to your operating
+system.
 
 The following overview will try to give you an idea of the use cases and
-advantages of vcsh. See sections 3 and 4 for detailed instructions and
+advantages of `vcsh`. See sections 3 and 4 for detailed instructions and
 examples.
 
 ## 2.1 Talks ##
 
-Some people found it useful to look at slides and videos explaining how vcsh works.
-They can all be found at [here](http://richardhartmann.de/talks/).
+Some people found it useful to look at slides and videos explaining how `vcsh`
+works.
+They can all be found [on the author's talk page][talks].
 
 # 3 Overview
 
@@ -213,12 +222,14 @@ If you are using Debian Squeeze, you will need to enable backports
 #### 4.1.2.2 Arch Linux ####
 
 vcsh is availabe via [AUR](https://aur.archlinux.org/packages.php?ID=54164)
+and further documentation about the use of AUR is available
+[on Arch's wiki](https://wiki.archlinux.org/index.php/Arch_User_Repository).
 
     cd /var/abs/local/
     wget https://aur.archlinux.org/packages/vc/vcsh-git/vcsh-git.tar.gz
     tar xfz vcsh-git.tar.gz
     cd vcsh-git
-    makepkg --asroot
+    makepkg -s
     pacman -U vcsh*.pkg.tar.xz
 
 #### 4.1.2.3 From source ####
@@ -371,8 +382,8 @@ manually. Alternatively, you could try something like this:
         vcsh run $repo git pull;
     done
 
-----------
-
-mr can be found at: [http://kitenet.net/~joey/code/mr/][1]
 
-[1]: http://kitenet.net/~joey/code/mr/ (http://kitenet.net/~joey/code/mr/)
+[mr]: http://kitenet.net/~joey/code/mr/
+[talks]: http://richardhartmann.de/talks/
+[vcsh]: https://github.com/RichiH/vcsh
+[vcs-home-list]: http://lists.madduck.net/listinfo/vcs-home