]> git.madduck.net Git - code/vcsh.git/commitdiff

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:

README.md: %s/</`/gc; %s/>/`/gc
authorRichard Hartmann <richih.mailinglist@gmail.com>
Sun, 9 Jun 2013 11:36:08 +0000 (13:36 +0200)
committerRichard Hartmann <richih.mailinglist@gmail.com>
Sun, 9 Jun 2013 11:36:08 +0000 (13:36 +0200)
README.md

index ab9e5f92a823368160c49ef473f944e1f99cdb41..78dca61594da1f27fde0ab981a89a4d89eec454a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ vcsh - Version Control System for $HOME (based on git)
 
 While it may appear that there's an overwhelming amount of documentation and
 while the explanation of the concepts behind `vcsh` needs to touch a few gory
-details of `git` internals, getting started with vcsh is extremely simple.
+details of `git` internals, getting started with `vcsh` is extremely simple.
 
 Let's say you want to version control your `vim` configuration:
 
@@ -51,7 +51,7 @@ community around the general idea of version controlling your (digital) life.
 [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.
+`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
@@ -63,7 +63,7 @@ or available to root and you may want to maintain different configuration for
 `vcsh` was designed with [mr][mr] in mind so you might want to install that, as
 well.
 
-Read <INSTALL.md> and <PACKAGING.md> for instructions specific to your operating
+Read `INSTALL.md` and `PACKAGING.md` for instructions specific to your operating
 system.
 
 The following overview will try to give you an idea of the use cases and
@@ -82,20 +82,20 @@ They can all be found [on the author's talk page][talks].
 ## Comparison to Other Solutions ##
 
 Most people who decide to put their dotfiles under version control start with a
-single repository in <$HOME>, adding all their dotfiles (and possibly more)
+single repository in `$HOME`, adding all their dotfiles (and possibly more)
 to it. This works, of course, but can become a nuisance as soon as you try to
 manage more than one host.
 
 The next logical step is to create single-purpose repositories in, for example,
-<~/.dotfiles> and to create symbolic links into <$HOME>. This gives you the
+`~/.dotfiles` and to create symbolic links into `$HOME`. This gives you the
 flexibility to check out only certain repositories on different hosts. The
 downsides of this approach are the necessary manual steps of cloning and
 symlinking the individual repositories.
 
 `vcsh` takes this second approach one step further. It expects
 single-purpose repositories and stores them in a hidden directory (similar
-to <~/.dotfiles>). However, it does not create symbolic links in <$HOME>; it
-puts the actual files right into <$HOME>.
+to `~/.dotfiles`). However, it does not create symbolic links in `$HOME`; it
+puts the actual files right into `$HOME`.
 
 Furthermore, by making use of [mr][mr], it makes it very easy to enable/disable
 and clone a large number of repositories. The use of `mr` is technically