]> git.madduck.net Git - code/vcsh.git/blobdiff - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge branch 'master' of github.com:RichiH/vcsh
[code/vcsh.git] / README.md
index c1b0f8d6806a1911844783ee230fce4241e12976..104114da71ae35c9c0e13c33ff98c92b0669f370 100644 (file)
--- a/README.md
+++ b/README.md
@@ -32,51 +32,51 @@ The use of mr is technically optional, but it will be an integral part of the pr
 
 To illustrate, this is what a possible directory structure looks like.
 
-        $HOME
-            |-- .config
-            |   |-- mr
-            |   |   |-- available.d
-            |   |   |   |-- zsh.vcsh
-            |   |   |   |-- gitconfigs.vcsh
-            |   |   |   |-- lftp.vcsh
-            |   |   |   |-- offlineimap.vcsh
-            |   |   |   |-- s3cmd.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
-            |   `-- vcsh
-            |       `-- repo.d
-            |           |-- zsh.git  -----------+
-            |           |-- gitconfigs.git      |
-            |           |-- tmux.git            |
-            |           `-- vim.git             |
-            |-- [...]                           |
-            |-- .zshrc   <----------------------+
-            |-- .gitignore
-            |-- .mrconfig
-            `-- .mrtrust
+    $HOME
+        |-- .config
+        |   |-- mr
+        |   |   |-- available.d
+        |   |   |   |-- zsh.vcsh
+        |   |   |   |-- gitconfigs.vcsh
+        |   |   |   |-- lftp.vcsh
+        |   |   |   |-- offlineimap.vcsh
+        |   |   |   |-- s3cmd.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
+        |   `-- vcsh
+        |       `-- repo.d
+        |           |-- zsh.git  -----------+
+        |           |-- gitconfigs.git      |
+        |           |-- tmux.git            |
+        |           `-- vim.git             |
+        |-- [...]                           |
+        |-- .zshrc   <----------------------+
+        |-- .gitignore
+        |-- .mrconfig
+        `-- .mrtrust
 
 In this setup, ~/.mrconfig looks like:
 
-        [DEFAULT]
-        jobs = 5
-        include = cat ~/.config/mr/config.d/*
+    [DEFAULT]
+    jobs = 5
+    include = cat ~/.config/mr/config.d/*
 
 The files you see in ~/.config/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.
 
-        [$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
+    [$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
 
 ~/.config/mr/available.d contains *all available* repositories.
 Only files/links present in mr/config.d, however, will be used by mr.