]> git.madduck.net Git - code/vcsh.git/blobdiff - INSTALL.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:

projects / code / vcsh.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update README.md
[code/vcsh.git] / INSTALL.md
diff --git a/INSTALL.md b/INSTALL.md
index 13f7b328825cfeed4fcc4729d8dca124fa744ca7..c69c010288e0c22a829076739a9733fe7ffe7a4b 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,130 +1,36 @@
-# Getting started with vcsh #
+# Pre-requisites #
 
-Below you will find three methods for setting up vcsh:
+If you want to build the manpage, you will need ronn. Newer versions of Debian come with a package:
 
-1. The template way
-2. The steal-from-template way
-3. The manual way
+    apt-get install ruby-ronn
 
-# 1. The template way #
 
-## Prerequisites ##
+# Installing #
 
-Make sure none of the following files/diretories exist for your test (user). If they do, move them away for now:
+    sudo make install
 
-* ~/.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/
 
-All of the files are part of the template repository, the directory is where the template will be stored.
+# Uninstalling #
 
-    apt-get install mr               # this is optional, but highly recommended
+    sudo make uninstall
 
-## Clone the template ##
+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.
 
-    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
+**THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT'S EMPTY, OTHERWISE**
 
-## Enable your test repository ##
+    sudo make purge
 
-    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'S EMPTY, OTHERWISE**
 
-## Set up your own repositories ##
+This is not in the default behaviour of `make uninstall` for obvious reasons.
 
-Now, it's time to edit the template config and fill it with your own remotes:
 
-    vim .config/mr/available.d/mr.vcsh
-    vim .config/mr/available.d/zsh.vcsh
+# Other stuff #
 
-And then create your own stuff:
+To clean up the generated manpag, run
 
-    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
+    make clean
 
-    cp .config/mr/available.d/mr.vcsh .config/mr/available.d/foo.vcsh
-    vim .config/mr/available.d/foo.vcsh # add your own repo
+and if you are bored, I suggest
 
-Done!
-
-## Daily use  ##
-
-### Keeping repositories up-to-date ###
-
-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
+    make moo
version controlled RC files

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.