Some fixes; formatting

[code/vcsh.git] / README.md

diff --git a/README.md b/README.md
index 104114da71ae35c9c0e13c33ff98c92b0669f370..0a9b1723a9b7a0da3531fe99a6575d2616402a04 100644 (file)
--- a/README.md
+++ b/README.md
@@ -21,9 +21,9 @@ This gives you the flexibility to check out only certain repositories on differe
 The downsides of this approach are the necessary manual steps of cloning and symlinking the individual repositories.
 It will probably become a nuisance when you try to manage more than two hosts.
 
 The downsides of this approach are the necessary manual steps of cloning and symlinking the individual repositories.
 It will probably become a nuisance when you try to manage more than two hosts.
 

-vcsh takes this second approach one step further.
-It expects single-purpose repositories and stores them in a hidden directory (similar to ~/.dotfiles).
-However, it does not create symbolic links in $HOME; it puts the actual files right into $HOME.
+**vcsh** takes this second approach one step further.
+It expects **single-purpose repositories** and stores them in a hidden directory (similar to ~/.dotfiles).
+However, it does not create symbolic links in $HOME; it puts the **actual files right into $HOME**.

 
 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, but it will be an integral part of the proposed system that follows.
 
 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, but it will be an integral part of the proposed system that follows.


@@ -44,12 +44,12 @@ To illustrate, this is what a possible directory structure looks like.
         |   |   |   |-- tmux.vcsh
         |   |   |   |-- vim.vcsh
         |   |   |   |-- vimperator.vcsh
         |   |   |   |-- tmux.vcsh
         |   |   |   |-- vim.vcsh
         |   |   |   |-- vimperator.vcsh

-        |   |   |   |-- snippets.git
-        |   |   |-- config.d
-        |   |   |   |-- zsh.mrconfig       -> ../available.d/zsh.mrconfig
-        |   |   |   |-- gitconfigs.mrconfig -> ../available.d/gitconfigs.mrconfig
-        |   |   |   |-- tmux.mrconfig       -> ../available.d/tmux.mrconfig
-        |   |   |   `-- vim.mrconfig        -> ../available.d/vim.mrconfig
+        |   |   |   `-- snippets.git
+        |   |   `-- config.d
+        |   |       |-- zsh.mrconfig        -> ../available.d/zsh.mrconfig
+        |   |       |-- gitconfigs.mrconfig -> ../available.d/gitconfigs.mrconfig
+        |   |       |-- tmux.mrconfig       -> ../available.d/tmux.mrconfig
+        |   |       `-- vim.mrconfig        -> ../available.d/vim.mrconfig

         |   `-- vcsh
         |       `-- repo.d
         |           |-- zsh.git  -----------+
         |   `-- vcsh
         |       `-- repo.d
         |           |-- zsh.git  -----------+


@@ -83,8 +83,8 @@ Only files/links present in mr/config.d, however, will be used by mr.
 That means 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.
 
 That means 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.
 

-~/.config/vcsh/repo.d is the directory where vcsh clones the git repositories into.
-Since their working trees are configured to be in $HOME, the files contained in those repositories will be put in $HOME directly (see .bashrc above).
+~/.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. Optionally, merge your local and your global configs afterwards and push with `vcsh run foo git push`.
 
 
 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. Optionally, merge your local and your global configs afterwards and push with `vcsh run foo git push`.
 


@@ -92,7 +92,7 @@ vcsh will check if any file it would want to create exists. If it exists, vcsh w
 
 To illustrate further, the following steps could move your desired configuration to a new host.
 
 
 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`
+1. Clone the mr repository (containing available.d, config.d etc.). For example: `vcsh clone git://github.com/RichiH/vcsh_mr_template.git`

 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`.
 4. Done.
 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`.
 4. Done.