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

README.md: Move mr farther down
[code/vcsh.git] / README.md
index 68031ff877ef0dd23dfb7733e0efbdedd350b421..743ed6864cb51c40a857ef7b402044d434c350b2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,10 +13,11 @@ vcsh - Version Control System for $HOME - multiple Git repositories in $HOME
 
 # Introduction
 
 
 # Introduction
 
-[vcsh][vcsh] allows you to maintain several git repositories in one single
+[vcsh][vcsh] allows you to maintain several Git repositories in one single
 directory. They all maintain their working trees without clobbering each other
 directory. They all maintain their working trees without clobbering each other
-or interfering otherwise. By default, all git repositories maintained via
-`vcsh` are stored in `$HOME` but you can override this setting if you want to.
+or interfering otherwise. By default, all Git repositories maintained via
+`vcsh` store the actual files in `$HOME` but you can override this setting if
+you want to.
 All this means that you can have one repository per application or application
 family, i.e. `zsh`, `vim`, `ssh`, etc. This, in turn, allows you to clone
 custom sets of configurations onto different machines or even for different
 All this means that you can have one repository per application or application
 family, i.e. `zsh`, `vim`, `ssh`, etc. This, in turn, allows you to clone
 custom sets of configurations onto different machines or even for different
@@ -25,12 +26,6 @@ For example, you may not need to have your `mplayer` configuration on a server
 or available to root and you may want to maintain different configuration for
 `ssh` on your personal and your work machines.
 
 or available to root and you may want to maintain different configuration for
 `ssh` on your personal and your work machines.
 
-`vcsh` was designed with [mr][mr], a tool to manage Multiple Repositories, in
-mind and the two integrate very nicely. `mr` has native support for `vcsh`
-repositories and to `vcsh`, `mr` is just another configuration to track.
-This make setting up any new machine a breeze. It takes literally less than
-five minutes to go from standard installation to fully set up system
-
 A lot of modern UNIX-based systems offer pacakges for `vcsh`. In case yours
 does not read `INSTALL.md` for install instructions or `PACKAGING.md` to create
 a package, yourself. If you do end up packaging `vcsh` please let us know so we
 A lot of modern UNIX-based systems offer pacakges for `vcsh`. In case yours
 does not read `INSTALL.md` for install instructions or `PACKAGING.md` to create
 a package, yourself. If you do end up packaging `vcsh` please let us know so we
@@ -56,8 +51,9 @@ Let's say you want to version control your `vim` configuration:
     vcsh vim commit -m 'Initial commit of my Vim configuration'
     # optionally push your files to a remote
     vcsh vim remote add origin <remote>
     vcsh vim commit -m 'Initial commit of my Vim configuration'
     # optionally push your files to a remote
     vcsh vim remote add origin <remote>
-    vcsh vim push origin master:master
-    vcsh vim branch --track master origin/master
+    vcsh vim push -u origin master
+    # from now on you can push additional commits like this
+    vcsh vim push
 
 If all that looks a _lot_ like standard `git`, that's no coincidence; it's
 a design feature.
 
 If all that looks a _lot_ like standard `git`, that's no coincidence; it's
 a design feature.
@@ -92,9 +88,12 @@ To manage both `vcsh` and other repositories, we suggest using [mr](mr). `mr`
 takes care of pulling in and pushing out new data for a variety of version
 control systems.
 
 takes care of pulling in and pushing out new data for a variety of version
 control systems.
 
+`vcsh` was designed with [mr][mr], a tool to manage Multiple Repositories, in
+mind and the two integrate very nicely. `mr` has native support for `vcsh`
+repositories and to `vcsh`, `mr` is just another configuration to track.
+This make setting up any new machine a breeze. It takes literally less than
+five minutes to go from standard installation to fully set up system
 
 
-The last logical step is to maintain all those new repositores with an automated
-tool instead of tracking them by hand.
 This is where `mr` comes in. While the use of `mr` is technically
 optional, but it will be an integral part of the proposed system that follows.
 
 This is where `mr` comes in. While the use of `mr` is technically
 optional, but it will be an integral part of the proposed system that follows.
 
@@ -365,7 +364,7 @@ ignore this fact for now and follow the examples.
 
 ## Initialize a new repository "vim"
 
 
 ## Initialize a new repository "vim"
 
-    vcsh init vcsh
+    vcsh init vim
 
 ## Clone an existing repository
 
 
 ## Clone an existing repository