+If you want to give vcsh a try, follow the instructions below.
+
+
+# Getting Started
+
+Below, you will find a few different methods for setting up vcsh:
+
+1. The Template Way
+2. The Steal-from-Template Way
+3. The Manual Way
+
+### The Template Way
+
+#### Prerequisites
+
+Make sure none of the following files and directories exist for your test
+(user). If they do, move them away for now:
+
+* `~/.gitignore.d`
+* `~/.mrconfig`
+* `$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.
+
+### Install vcsh
+
+#### Debian
+
+If you are using Debian Squeeze, you will need to enable backports and the
+package name for myrepos will be 'mr'.
+
+From Wheezy onwards, you can install both directly:
+
+ apt-get install myrepos vcsh
+
+#### Gentoo
+
+To install vcsh in Gentoo Linux just give the following command as root:
+
+ emerge dev-vcs/vcsh
+
+Note the portage package for myrepos still has the old project name:
+
+ emerge dev-vcs/mr
+
+#### Arch Linux
+
+vcsh is available via this [AUR](https://aur.archlinux.org/packages/vcsh/)
+package. Likewise myrepos is available [here](https://aur.archlinux.org/packages/myrepos/).
+You may install both useing your favorite AUR helper. e.g. with yaourt:
+
+ yaourt -Sya myrepos vcsh
+
+Or you can do it yourself manually using the documentation on installing AUR packages
+[on Arch's wiki](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages).
+
+If you prefer to use the devel package that installs the git HEAD version it
+is available [here](https://aur.archlinux.org/packages/vcsh-git/).
+
+#### Mac OS X
+
+Formulas are available for vcsh as well as git and myrepos through [homebrew](http://brew.sh). The
+vcsh formula is set to depend on myrepos, so you only need one install command:
+
+ brew install vcsh
+
+#### From source
+
+To install the latest version from git:
+
+ # choose a location for your checkout
+ mkdir -p ~/work/git
+ cd ~/work/git
+ git clone git://github.com/RichiH/vcsh.git
+ cd vcsh
+ sudo ln -s vcsh /usr/local/bin # or add it to your PATH
+
+For myrepos:
+
+ # use checkout location from above
+ cd ~/work/git
+ git clone git://myrepos.branchable.com/ myrepos
+ cd myrepos
+ make install
+
+#### Clone the Template
+
+ vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr
+
+#### Enable Your Test Repository
+
+ mv ~/.zsh ~/zsh.bak
+ mv ~/.zshrc ~/zshrc.bak
+ cd $XDG_CONFIG_HOME/mr/config.d/
+ ln -s ../available.d/zsh.vcsh . # link, and thereby enable, the zsh repository
+ cd
+ mr up
+
+#### Set Up Your Own Repositories
+
+Now, it's time to edit the template config and fill it with your own remotes:
+
+ vim $XDG_CONFIG_HOME/mr/available.d/mr.vcsh
+ vim $XDG_CONFIG_HOME/mr/available.d/zsh.vcsh
+
+And then create your own stuff:
+
+ vcsh init foo
+ vcsh foo add bar baz quux
+ vcsh foo remote add origin git://quuux
+ vcsh foo commit
+ vcsh foo push
+
+ 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!
+
+### The Steal-from-Template Way
+
+You're welcome to clone the example repository:
+
+ vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr
+ # make sure 'include = cat /usr/share/mr/vcsh' points to an exiting file
+ vim .mrconfig
+
+Look around in the clone. It should be reasonably simple to understand. If not,
+poke me, RichiH, on Freenode (query) or OFTC (#vcs-home).
+
+
+### The Manual Way
+
+This is how my old setup procedure looked like. Adapt it to your own style or
+copy mine verbatim, either is fine.
+
+ # Create workspace
+ mkdir -p ~/work/git
+ cd !$
+
+ # Clone vcsh and make it available
+ git clone git://github.com/RichiH/vcsh.git vcsh
+ sudo ln -s ~/work/git/vcsh/vcsh /usr/bin/local
+ hash -r
+
+Grab my myrepos config. see below for details on how I set this up
+
+ vcsh clone ssh://<remote>/mr.git
+ cd $XDG_CONFIG_HOME/mr/config.d/
+ ln -s ../available.d/* .
+
+
+[myrepos][myrepos] is used to actually retrieve configs, etc.
+
+ ~ % cat ~/.mrconfig
+ [DEFAULT]
+ 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
+ git-annex gitk.vcsh git.vcsh ikiwiki mr.vcsh reportbug.vcsh snippets.git wget.vcsh zsh.vcsh
+ ~ %
+ # then simply ln -s whatever you want on your local machine from
+ # $XDG_CONFIG_HOME/mr/available.d to $XDG_CONFIG_HOME/mr/config.d
+ ~ % cd
+ ~ % mr -j 5 up
+
+
+# myrepos usage ; will be factored out & rewritten
+
+### Keeping repositories Up-to-Date
+
+This is the beauty of it all. Once you are set up, just run:
+
+ mr up
+ mr push
+
+Neat.
+
+### Making Changes
+
+After you have made some changes, for which you would normally use `git add`
+and `git commit`, use the vcsh wrapper (like above):
+
+ vcsh foo add bar baz quux
+ vcsh foo commit
+ vcsh foo push
+
+### Using vcsh without myrepos
+
+vcsh encourages you to use [myrepos][myrepos]. It helps you manage a large number of
+repositories by running the necessary vcsh commands for you. You may choose not
+to use myrepos, in which case you will have to run those commands manually or by
+other means.
+
+
+To initialize a new repository: `vcsh init zsh`
+
+To clone a repository: `vcsh clone ssh://<remote>/zsh.git`
+
+To interact with a repository, use the regular Git commands, but prepend them
+with `vcsh run $repository_name`. For example:
+
+ vcsh zsh status
+ vcsh zsh add .zshrc
+ vcsh zsh commit
+
+Obviously, without myrepos keeping repositories up-to-date, it will have to be done
+manually. Alternatively, you could try something like this:
+
+ for repo in `vcsh list`; do
+ vcsh run $repo git pull;
+ 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]
+
projects / code / vcsh.git / blobdiff