X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/034e25b7c4de8e60676f9a9ed7cd085a083083a9..f0e806b4189e61fec4a3dcd3164ed2a58e56bcce:/README.md diff --git a/README.md b/README.md index d761c82..21c52cd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -vcsh - manage and sync config files via git +vcsh - manage config files in $HOME via fake bare git repositories # Index # @@ -83,6 +83,7 @@ To illustrate, this is what a possible directory structure looks like. | | |-- tmux.vcsh -> ../available.d/tmux.vcsh | | `-- vim.vcsh -> ../available.d/vim.vcsh | `-- vcsh + | |-- config | `-- repo.d | |-- zsh.git -----------+ | |-- gitconfigs.git | @@ -90,7 +91,8 @@ To illustrate, this is what a possible directory structure looks like. | `-- vim.git | |-- [...] | |-- .zshrc <----------------------+ - |-- .gitignore + |-- .gitignore.d + | `-- zsh |-- .mrconfig `-- .mrtrust @@ -150,7 +152,7 @@ To illustrate further, the following steps could move your desired configuration to a new host. 1. Clone the mr repository (containing available.d, config.d etc.); for - example: `vcsh clone git://github.com/RichiH/vcsh_mr_template.git` + example: `vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr` 2. Choose your repositories by linking them in config.d (or go with the default you may have already configured by adding symlinks to git). 3. Run mr to clone the repositories: `cd; mr update`. @@ -179,7 +181,7 @@ Below, you will find a few different methods for setting up vcsh: Make sure none of the following files and directories exist for your test (user). If they do, move them away for now: -* ~/.gitignore +* ~/.gitignore.d * ~/.mrconfig * $XDG_CONFIG_HOME/mr/available.d/mr.vcsh * $XDG_CONFIG_HOME/mr/available.d/zsh.vcsh @@ -199,7 +201,7 @@ the template will be stored. cd vcsh ln -s vcsh /usr/local/bin # or add it to your PATH cd - vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr.vcsh + vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr #### 4.1.3 Enable Your Test Repository #### @@ -234,7 +236,7 @@ Done! You're welcome to clone the example repository: - git clone git://github.com/RichiH/vcsh_mr_template.git + vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr Look around in the clone. It should be reasonably simple to understand. If not, poke me, RichiH, on Freenode (query) or OFTC (#vcs-home).