-vcsh - manage and sync config files via git
+vcsh - manage config files in $HOME via fake bare git repositories
# Index #
-1. Introduction
-2. Overview
-3. Getting Started
-4. Usage
+1. Contact
+2. Introduction
+3. Overview
+4. Getting Started
+5. Usage
-# 1 Introduction #
+# 1 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: vcs-home@lists.madduck.net
+
+* Pull requests or issues on https://github.com/RichiH/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
advantages of vcsh. See sections 3 and 4 for detailed instructions and
examples.
-# 2 Overview
+# 3 Overview
-## 2.1 Comparison to Other Solutions ##
+## 3.1 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)
Furthermore, by making use of [mr] [1], it makes it very easy to enable/disable
and clone a large number of repositories. The use of mr is technically optional
-(see 3.4), but it will be an integral part of the proposed system that follows.
+(see 4.3), but it will be an integral part of the proposed system that follows.
-## 2.2 Default Directory Layout ##
+## 3.2 Default Directory Layout ##
To illustrate, this is what a possible directory structure looks like.
### available.d ###
-The files you see in $XDG_CONFIG_HOME/mr/available.d are mr configuration files that
-contain the commands to manage (checkout, update etc.) a single repository.
-vcsh repo configs end in .vcsh, git configs end in .git, etc. This is optional
-and your preference. For example, this is what a zsh.mrconfig with read-only
-access to my zshrc repo looks likes. I.e. in this specific example, push can
-not work.
+The files you see in $XDG_CONFIG_HOME/mr/available.d are mr configuration files
+that contain the commands to manage (checkout, update etc.) a single
+repository. vcsh repo configs end in .vcsh, git configs end in .git, etc. This
+is optional and your preference. For example, this is what a zsh.vcsh
+with read-only access to my zshrc repo looks likes. I.e. in this specific
+example, push can not work as you will be using the author's repository. This
+is for demonstration, only. Of course, you are more than welcome to clone from
+this repository and fork your own.
[$XDG_CONFIG_HOME/vcsh/repo.d/zsh.git]
checkout = vcsh clone 'git://github.com/RichiH/zshrc.git' zsh
Optionally, merge your local and your global configs afterwards and push with
`vcsh run foo git push`.
-## 2.3 Moving into a New Host ##
+## 3.3 Moving into a New Host ##
To illustrate further, the following steps could move your desired
configuration to a new host.
If you want to give vcsh a try, follow the instructions below.
-# 3 Getting Started #
+# 4 Getting Started #
Below, you will find a few different methods for setting up vcsh:
-3.1. The Template Way
-3.2. The Steal-from-Template Way
-3.3. The Manual Way
+1. The Template Way
+2. The Steal-from-Template Way
+3. The Manual Way
-### 3.1 The Template Way ###
+### 4.1 The Template Way ###
-#### 3.1.1 Prerequisites ####
+#### 4.1.1 Prerequisites ####
Make sure none of the following files and directories exist for your test
(user). If they do, move them away for now:
apt-get install mr
-#### 3.1.2 Clone the Template ####
+#### 4.1.2 Clone the Template ####
mkdir -p ~/work/git
cd !$
cd
vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr.vcsh
-#### 3.1.3 Enable Your Test Repository ####
+#### 4.1.3 Enable Your Test Repository ####
mv ~/.zsh ~/zsh.bak
mv ~/.zshrc ~/zshrc.bak
cd
mr up
-#### 3.1.4 Set Up Your Own Repositories ####
+#### 4.1.4 Set Up Your Own Repositories ####
Now, it's time to edit the template config and fill it with your own remotes:
Done!
-### 3.2 The Steal-from-Template Way ###
+### 4.2 The Steal-from-Template Way ###
You're welcome to clone the example repository:
poke me, RichiH, on Freenode (query) or OFTC (#vcs-home).
-### 3.3 The Manual Way ###
+### 4.3 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.
~ % cd
~ % mr -j 5 up
-# 4 Usage #
+# 5 Usage #
-### 4.1 Keeping repositories Up-to-Date ###
+### 5.1 Keeping repositories Up-to-Date ###
This is the beauty of it all. Once you are set up, just run:
Neat.
-### 4.1 Making Changes ###
+### 5.1 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):
will be ignored by default. This is to show you only useful output when running
git-status. A fix for this problem is being worked on.
-### 4.3 Using vcsh without mr ###
+### 5.3 Using vcsh without mr ###
-vcsh encourages you to use mr. It helps you manage a large number of
+vcsh encourages you to use [mr] [1]. It helps you manage a large number of
repositories by running the necessary vcsh commands for you. You may choose not
to use mr, in which case you will have to run those commands manually or by
other means.
projects / code / vcsh.git / blobdiff