X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/b3e58bee42e266888583c0b0bbf4347fd6ac0ad2..2a00efaf0694408a3579fb2ac6595f5151dfd2c1:/README.md diff --git a/README.md b/README.md index 78dca61..4f7c27a 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ vcsh - Version Control System for $HOME (based on git) # Index # 1. [30 second howto](#30-second-howto) -2. [Contact](#contact) -3. [Introduction](#introduction) -4. [Overview](#overview) -5. [Getting Started](#getting-started) -6. [Usage](#usage) +2. [Introduction](#introduction) +3. [Overview](#overview) +4. [Getting Started](#getting-started) +5. [Usage](#usage) +6. [Contact](#contact) # 30 second howto # @@ -34,25 +34,13 @@ into more advanced usage scenarios, especially on how to manage your `vcsh` and other repositories with [mr][mr]. -# Contact # - -There are several ways to get in touch with the author and a small but committed -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][vcs-home-list] - -* Pull requests or issues on [https://github.com/RichiH/vcsh][vcsh] - - # Introduction # [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 +All this 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. @@ -66,14 +54,11 @@ well. 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 -advantages of `vcsh`. See sections 3 and 4 for detailed instructions and -examples. ## Talks ## Some people found it useful to look at slides and videos explaining how `vcsh` -works. +works instead of working through the docs, first. They can all be found [on the author's talk page][talks]. @@ -413,6 +398,18 @@ manually. Alternatively, you could try something like this: done +# Contact # + +There are several ways to get in touch with the author and a small but committed +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][vcs-home-list] + +* Pull requests or issues on [https://github.com/RichiH/vcsh][vcsh] + + [mr]: http://kitenet.net/~joey/code/mr/ [talks]: http://richardhartmann.de/talks/ [vcsh]: https://github.com/RichiH/vcsh