]> git.madduck.net Git - code/vcsh.git/commitdiff

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 usage examples up
authorRichard Hartmann <richih@debian.org>
Wed, 14 Aug 2013 06:59:27 +0000 (08:59 +0200)
committerRichard Hartmann <richih@debian.org>
Wed, 14 Aug 2013 06:59:27 +0000 (08:59 +0200)
README.md

index 743ed6864cb51c40a857ef7b402044d434c350b2..c0b7cd3ff7ca6b92619a79ce2ed34fd508baf0d3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,14 +3,35 @@ vcsh - Version Control System for $HOME - multiple Git repositories in $HOME
 
 # Index
 
 
 # Index
 
-1. [Introduction](#introduction)
-2. [30 second howto](#30-second-howto)
-3. [Overview](#overview)
-4. [Getting Started](#getting-started)
-5. [Usage Exmaples](#usage-examples)
+1. [30 second howto](#30-second-howto)
+2. [Introduction](#introduction)
+3. [Usage Exmaples](#usage-examples)
+4. [Overview](#overview)
+5. [Getting Started](#getting-started)
 6. [Contact](#contact)
 
 
 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 -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.
+
+
 # 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
@@ -34,29 +55,45 @@ can give you your own packaging branch in the upstream repository.
 ## Talks
 
 Some people found it useful to look at slides and videos explaining how `vcsh`
 ## Talks
 
 Some people found it useful to look at slides and videos explaining how `vcsh`
-works instead of working through the docs, first.
-They can all be found [on the author's talk page][talks].
+works instead of working through the docs.
+All slides, videos, and further information can be found
+[on the author's talk page][talks].
 
 
 
 
-# 30 second howto
+# Usage Examples
 
 
-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.
+There are three different ways to interact with `vcsh` repositories; this
+section will only show the simplest and easiest way.
+Certain more advanced use cases require the other two ways, but don't worry
+about this for now. This will be covered in the advanced sections.
 
 
-Let's say you want to version control your `vim` configuration:
+## Initialize a new repository "vim"
 
     vcsh init vim
 
     vcsh init vim
+
+## Clone an existing repository
+
+    vcsh clone <remote> <repository_name>
+
+## Add files to repository "vim"
+
     vcsh vim add ~/.vimrc ~/.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 commit -m 'Update Vim configuration'
+
+## Add a remote for repository "vim"
+
     vcsh vim remote add origin <remote>
     vcsh vim remote add origin <remote>
-    vcsh vim push -u origin master
-    # from now on you can push additional commits like this
+    vcsh vim push origin master:master
+    vcsh vim branch --track master origin/master
+
+## Push to remote of repository "vim"
+
     vcsh vim push
 
     vcsh vim push
 
-If all that looks a _lot_ like standard `git`, that's no coincidence; it's
-a design feature.
+## Pull from remote of repository "vim"
+
+    vcsh vim pull
+
 
 
 # Overview
 
 
 # Overview
@@ -356,40 +393,6 @@ mr is used to actually retrieve configs, etc
     ~ % mr -j 5 up
 
 
     ~ % mr -j 5 up
 
 
-# Usage Examples
-
-All examples in this section will use the short form of `vcsh` which is the
-simplest way to interface with it. If you don't know what that means simply
-ignore this fact for now and follow the examples.
-
-## Initialize a new repository "vim"
-
-    vcsh init vim
-
-## Clone an existing repository
-
-    vcsh clone <remote> <repository_name>
-
-## Add files to repository "vim"
-
-    vcsh vim add ~/.vimrc ~/.vim
-    vcsh vim commit -m 'Update Vim configuration'
-
-## Add a remote for repository "vim"
-
-    vcsh vim remote add origin <remote>
-    vcsh vim push origin master:master
-    vcsh vim branch --track master origin/master
-
-## Push to remote of repository "vim"
-
-    vcsh vim push
-
-## Pull from remote of repository "vim"
-
-    vcsh vim pull
-
-
 # mr usage ; will be factored out & rewritten
 
 ### Keeping repositories Up-to-Date
 # mr usage ; will be factored out & rewritten
 
 ### Keeping repositories Up-to-Date