Skip to main content
Sign in
Snippets Groups Projects
Commit eaa2b712 authored by Richard Hartmann's avatar Richard Hartmann
Browse files

README.md: Move Introduction to beginning

parent cde27977
Branches
Tags
No related merge requests found
...@@ -3,37 +3,14 @@ vcsh - Version Control System for $HOME (based on git) ...@@ -3,37 +3,14 @@ vcsh - Version Control System for $HOME (based on git)
# Index # # Index #
1. [30 second howto](#30-second-howto) 1. [Introduction](#introduction)
2. [Introduction](#introduction) 2. [30 second howto](#30-second-howto)
3. [Overview](#overview) 3. [Overview](#overview)
4. [Getting Started](#getting-started) 4. [Getting Started](#getting-started)
5. [Usage](#usage) 5. [Usage](#usage)
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 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 # # 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
...@@ -60,6 +37,29 @@ a package, yourself. If you do end up packaging `vcsh` please let us know so we ...@@ -60,6 +37,29 @@ 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. can give you your own packaging branch in the upstream repository.
# 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].
## Talks ## ## Talks ##
Some people found it useful to look at slides and videos explaining how `vcsh` Some people found it useful to look at slides and videos explaining how `vcsh`
... ...
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment