README.md

   1 vcsh - Version Control System for $HOME - multiple Git repositories in $HOME
   2 [![Build Status](https://travis-ci.org/RichiH/vcsh.svg)](https://travis-ci.org/RichiH/vcsh)
   3
   4
   5 # Index
   6
   7 1. [30 Second How-to](#30-second-how-to)
   8 2. [Introduction](#introduction)
   9 3. [Contact](#contact)
  10
  11
  12 # 30 Second How-to
  13
  14 While it may appear that there's an overwhelming amount of documentation and
  15 while the explanation of the concepts behind `vcsh` needs to touch a few gory
  16 details of `git` internals, getting started with `vcsh` is extremely simple.
  17
  18 Let's say you want to version control your `vim` configuration:
  19
  20     vcsh init vim
  21     vcsh vim add ~/.vimrc ~/.vim
  22     vcsh vim commit -m 'Initial commit of my Vim configuration'
  23     # optionally push your files to a remote
  24     vcsh vim remote add origin <remote>
  25     vcsh vim push -u origin master
  26     # from now on you can push additional commits like this
  27     vcsh vim push
  28
  29 If all that looks a _lot_ like standard `git`, that's no coincidence; it's
  30 a design feature.
  31
  32
  33 # Introduction
  34
  35 [vcsh][vcsh] allows you to maintain several Git repositories in one single
  36 directory. They all maintain their working trees without clobbering each other
  37 or interfering otherwise. By default, all Git repositories maintained via
  38 `vcsh` store the actual files in `$HOME` but you can override this setting if
  39 you want to.
  40
  41 All this means that you can have one repository per application or application
  42 family, i.e. `zsh`, `vim`, `ssh`, etc. This, in turn, allows you to clone
  43 custom sets of configurations onto different machines or even for different
  44 users; picking and mixing which configurations you want to use where.
  45 For example, you may not need to have your `mplayer` configuration on a server
  46 or available to root and you may want to maintain different configuration for
  47 `ssh` on your personal and your work machines.
  48
  49 A lot of modern UNIX-based systems offer packages for `vcsh`. In case yours
  50 does not, read [INSTALL.md](doc/INSTALL.md) for install instructions or
  51 [PACKAGING.md](doc/PACKAGING.md) to create a package yourself. If you do end
  52 up packaging `vcsh` please let us know so we can give you your own packaging
  53 branch in the upstream repository.
  54
  55 ## Talks
  56
  57 Some people found it useful to look at slides and videos explaining how `vcsh`
  58 works instead of working through the docs.
  59 All slides, videos, and further information can be found
  60 [on the author's talk page][talks].
  61
  62
  63 # Contact
  64
  65 There are several ways to get in touch with the author and a small but committed
  66 community around the general idea of version controlling your (digital) life.
  67
  68 * IRC: #vcs-home on irc.oftc.net
  69
  70 * Mailing list: [http://lists.madduck.net/listinfo/vcs-home][vcs-home-list]
  71
  72 * Pull requests or issues on [https://github.com/RichiH/vcsh][vcsh]
  73
  74
  75 [myrepos]: http://myrepos.branchable.com/
  76 [talks]: http://richardhartmann.de/talks/
  77 [vcsh]: https://github.com/RichiH/vcsh
  78 [vcs-home-list]: http://lists.madduck.net/listinfo/vcs-home