]> 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 'Talks' back into 'Intorudction'
[code/vcsh.git] / README.md
index 4f7c27af3eee9344640ce09988117ccb8f671684..4ecb54fc0df160225156fa6b2105d3e863bbee76 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,37 +3,14 @@ vcsh - Version Control System for $HOME (based on git)
 
 # Index #
 
 
 # Index #
 
-1. [30 second howto](#30-second-howto)
-2. [Introduction](#introduction)
+1. [Introduction](#introduction)
+2. [30 second howto](#30-second-howto)
 3. [Overview](#overview)
 4. [Getting Started](#getting-started)
 5. [Usage](#usage)
 6. [Contact](#contact)
 
 
 3. [Overview](#overview)
 4. [Getting Started](#getting-started)
 5. [Usage](#usage)
 6. [Contact](#contact)
 
 
-# 30 second howto #
-
-While it may appear that there's an overwhelming amount of documentation and
-while the explanation of the concepts behind `vcsh` needs to touch a few gory
-details of `git` internals, getting started with `vcsh` is extremely simple.
-
-Let's say you want to version control your `vim` configuration:
-
-    vcsh init vim
-    vcsh vim add ~/.vimrc ~/.vim
-    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
-
-If all that looks a _lot_ like standard `git`, that's no coincidence; it's
-a design feature.
-
-Once you get familiar with `vcsh`, it's strongly suggested that you look
-into more advanced usage scenarios, especially on how to manage your
-`vcsh` and other repositories with [mr][mr].
-
-
 # Introduction #
 
 [vcsh][vcsh] allows you to maintain several git repositories in one single
 # Introduction #
 
 [vcsh][vcsh] allows you to maintain several git repositories in one single
@@ -48,12 +25,16 @@ 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] in mind so you might want to install that, as
-well.
-
-Read `INSTALL.md` and `PACKAGING.md` for instructions specific to your operating
-system.
+`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
+can give you your own packaging branch in the upstream repository.
 
 ## Talks ##
 
 
 ## Talks ##
 
@@ -62,6 +43,25 @@ works instead of working through the docs, first.
 They can all be found [on the author's talk page][talks].
 
 
 They can all be found [on the author's talk page][talks].
 
 
+# 30 second howto #
+
+While it may appear that there's an overwhelming amount of documentation and
+while the explanation of the concepts behind `vcsh` needs to touch a few gory
+details of `git` internals, getting started with `vcsh` is extremely simple.
+
+Let's say you want to version control your `vim` configuration:
+
+    vcsh init vim
+    vcsh vim add ~/.vimrc ~/.vim
+    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
+
+If all that looks a _lot_ like standard `git`, that's no coincidence; it's
+a design feature.
+
+
 # Overview
 
 ## Comparison to Other Solutions ##
 # Overview
 
 ## Comparison to Other Solutions ##