From: Richard Hartmann Date: Thu, 17 Nov 2011 23:35:44 +0000 (+0100) Subject: Clean and fix docs a bit X-Git-Url: https://git.madduck.net/code/vcsh.git/commitdiff_plain/ef369a31786e19bec1b56460f8ceb2bcf3801d71 Clean and fix docs a bit --- diff --git a/README.md b/README.md index 6c59618..c40ccf4 100644 --- a/README.md +++ b/README.md @@ -92,11 +92,11 @@ access to my zshrc repo looks likes. I.e. in this specific example, push can not work. [$HOME/.config/vcsh/repo.d/zsh.git] - checkout = vcsh clone 'git://github.com/RichiH/zshrc.git' - update = vcsh run bash git pull - push = vcsh run bash git push - status = vcsh run bash git status - gc = vcsh run bash git gc + checkout = vcsh clone 'git://github.com/RichiH/zshrc.git' zsh + update = vcsh run zsh git pull + push = vcsh run zsh git push + status = vcsh run zsh git status + gc = vcsh run zsh git gc ### config.d ### @@ -106,13 +106,6 @@ that in this example, only the zsh, gitconfigs, tmux and vim repositories will be checked out. A simple `mr update` run in $HOME will clone or update those four repositories listed in config.d. -### repo.d ### - -~/.config/vcsh/repo.d is the directory into which vcsh clones the git -repositories. Since their working trees are configured to be in $HOME, the -files contained in those repositories will be put in $HOME directly (see .zshrc -above). - ### ~/.mrconfig ### Finally, ~/.mrconfig will tie together all those single files which will allow @@ -123,6 +116,13 @@ this: jobs = 5 include = cat ~/.config/mr/config.d/* +### repo.d ### + +~/.config/vcsh/repo.d is the directory into which vcsh clones the git +repositories. Since their working trees are configured to be in $HOME, the +files contained in those repositories will be put in $HOME directly (see .zshrc +above). + vcsh will check if any file it would want to create exists. If it exists, vcsh will throw a warning and exit. Move away your old config and try again. @@ -153,9 +153,9 @@ If you want to give vcsh a try, follow the instructions below. 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 +3.1. The Template Way +3.2. The Steal-from-Template Way +3.3. The Manual Way ### 3.1 The Template Way ### @@ -174,7 +174,7 @@ Make sure none of the following files and directories exist for your test All of the files are part of the template repository, the directory is where the template will be stored. - apt-get install mr # this is optional, but highly recommended + apt-get install mr #### 3.1.2 Clone the Template ####