]> 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:

projects / code / vcsh.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Add a comma
[code/vcsh.git] / README.md
diff --git a/README.md b/README.md
index 4263ad0a130628a0f152f6644b5f03ede880b83f..104114da71ae35c9c0e13c33ff98c92b0669f370 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,56 +26,57 @@ It expects single-purpose repositories and stores them in a hidden directory (si
 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.
 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.
 
 ## Default Directory Layout ##
 
 To illustrate, this is what a possible directory structure looks like.
 
 
 ## Default Directory Layout ##
 
 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:
 
 
 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.
 
 
 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.
 
 ~/.config/mr/available.d contains *all available* repositories.
 Only files/links present in mr/config.d, however, will be used by mr.
version controlled RC files

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.