vcsh: s/git/Git/

[code/vcsh.git] / INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
index f61166f55ebc82dccf037c98f6e028e3958d32ff..29c9889194866fd66a256374e406a799cdd2dd7b 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,160 +1,45 @@
-# Getting started with vcsh #
+# Pre-requisites #

 
 

-Below you will find a few different methods for setting up vcsh:
+If you want to build the manpage, you will need [ronn] [1].
+Debian 7.0 and above come with a package, so do most Debian clones.

 
 

-1. The template way
-2. The steal-from-template way
-3. The manual way
-4. Using vcsh without mr
+To install ronn on your Debian-based system, simply run

 
 

-# 1. The template way #
+       apt-get install ruby-ronn

 
 

-## Prerequisites ##
+There are no other dependencies other than `git`, `ronn` and a POSIX shell.

 
 

-Make sure none of the following files/diretories exist for your test (user). If they do, move them away for now:

 
 

-* ~/.gitignore
-* ~/.mrconfig
-* ~/.config/mr/available.d/mr.vcsh
-* ~/.config/mr/available.d/zsh.vcsh
-* ~/.config/mr/config.d/mr.vcsh
-* ~/.config/vcsh/repo.d/mr.git/
+# Installing #

 
 

-All of the files are part of the template repository, the directory is where the template will be stored.
+       sudo make install

 
 

-    apt-get install mr               # this is optional, but highly recommended

 
 

-## Clone the template ##
+# Uninstalling #

 
 

-    mkdir -p ~/work/git
-    cd !$
-    git clone git://github.com/RichiH/vcsh.git vcsh
-    cd vcsh
-    ln -s vcsh /usr/local/bin        # or add it to your PATH
-    cd
-    vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr.vcsh
+       sudo make uninstall

 
 

-## Enable your test repository ##
+There is another, more thorough, version. Just make sure you are not running
+this when you have installed to an important directory which is empty,
+otherwise.

 
 

-    mv ~/.zsh   ~/zsh.bak
-    mv ~/.zshrc ~/zshrc.bak
-    cd ~/.config/mr/config.d/
-    ln -s ../available.d/zsh.vcsh .  # link, and thereby enable, the zsh repository
-    cd
-    mr up
+**THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT BECOMES EMPTY**

 
 

-## Set up your own repositories ##
+       sudo make purge

 
 

-Now, it's time to edit the template config and fill it with your own remotes:
+**THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT BECOMES EMPTY**

 
 

-    vim .config/mr/available.d/mr.vcsh
-    vim .config/mr/available.d/zsh.vcsh
+This is not in the default behaviour of `make uninstall` for obvious reasons.

 
 

-And then create your own stuff:

 
 

-    vcsh init foo
-    vcsh run foo git add -f bar baz quux
-    vcsh run foo git remote add origin git://quuux
-    vcsh run foo git commit
-    vcsh run foo git push
+# Other stuff #

 
 

-    cp .config/mr/available.d/mr.vcsh .config/mr/available.d/foo.vcsh
-    vim .config/mr/available.d/foo.vcsh # add your own repo
+To clean up the generated manpage, run

 
 

-Done!
+       make clean

 
 

-## Daily use  ##
+and if you are bored, I suggest

 
 

-### Keeping repositories up-to-date ###
+       make moo

 
 

-This is the beauty of it all. Once you are set up, just run:
-
-   mr up
-   mr push
-
-Neat.
-
-### Making changes ###
-
-After you have made some changes, for which you would normally use `git add` and `git commit`, use the vcsh wrapper (like above):
-
-    vcsh run foo git add -f bar baz quux
-    vcsh run foo git commit
-    vcsh run foo git push
-
-By the way, you'll have to use -f/--force flag with git-add because all files will be ignored by default. This is to show you only useful output when running git-status.
-A fix for this problem is being worked on.
-
-
-# 2. The steal-from-template way #
-
-You're welcome to clone the example repository:
-
-    git clone git://github.com/RichiH/vcsh_mr_template.git
-
-Look around in the clone. It should be reasonably simple to understand. If not, poke me, RichiH, on Freenode (query) or OFTC (#vcs-home).
-
-
-# 3. The manual way #
-
-This is how my old setup procedure looked like. Adapt it to your own style or copy mine verbatim, either is fine.
-
-    # Create workspace
-    mkdir -p ~/work/git
-    cd !$
-
-    # Clone vcsh and make it available
-    git clone git://github.com/RichiH/vcsh.git vcsh
-    sudo ln -s ~/work/git/vcsh/vcsh /usr/bin/local
-    hash -r
-
-Grab my mr config. see below for details on how I set this up
-
-    vcsh clone ssh://<remote>/mr.git
-    cd ~/.config/mr/config.d/
-    ln -s ../available.d/* .
-
-
-mr is used to actually retrieve configs, etc
-
-    ~ % cat ~/.mrconfig
-    [DEFAULT]
-    include = cat ~/.config/mr/config.d/*
-    ~ % echo $XDG_CONFIG_HOME
-    /home/richih/.config
-    ~ % ls $XDG_CONFIG_HOME/mr/available.d # random selection of my repos
-    git-annex gitk.vcsh git.vcsh ikiwiki mr.vcsh reportbug.vcsh snippets.git wget.vcsh zsh.vcsh
-    ~ %
-    # then simply ln -s whatever you want on your local machine from
-    # $XDG_CONFIG_HOME/mr/available.d to $XDG_CONFIG_HOME/mr/config.d
-    ~ % cd
-    ~ % mr -j 5 up
-
-# 4. Using vcsh without mr #
-
-vcsh encourages you to use mr.
-It helps you manage a large number of repositories by running the necessary vcsh commands for you.
-You may choose not to use mr, in which case you will have to run those commands manually or by other means.
-
-## A few examples ##
-
-To initialize a new repository: `vcsh init zsh`
-
-To clone a repository: `vcsh clone ssh://<remote>/zsh.git`
-
-To interact with a repository, use the regular Git commands, but prepend them with `vcsh run $repository_name`.
-For example:
-
-    vcsh run zsh git status
-    vcsh run zsh git add -f .zshrc
-    vcsh run zsh git commit
-
-Obviously, without mr keeping repositories up-to-date, it will have to be done manually.
-Alternatively, you could try something like this:
-
-    for repo in `vcsh list`; do
-        vcsh run $repo git pull;
-    done
-
-----------
-Questions? RichiH@{Freenode,OFTC,IRCnet}
+[1]: http://rtomayko.github.io/ronn/