]> 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
vcsh: s/git/Git/
[code/vcsh.git] / INSTALL.md
diff --git a/INSTALL.md b/INSTALL.md
index 0df294d222eadbae5384f71912f3da16fe1a88ff..29c9889194866fd66a256374e406a799cdd2dd7b 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,26 +1,33 @@
 # Pre-requisites #
 
-If you want to build the manpage, you will need ronn. Newer versions of Debian come with a package:
+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.
 
-    apt-get install ruby-ronn
+To install ronn on your Debian-based system, simply run
+
+       apt-get install ruby-ronn
+
+There are no other dependencies other than `git`, `ronn` and a POSIX shell.
 
 
 # Installing #
 
-    sudo make install
+       sudo make install
 
 
 # Uninstalling #
 
-    sudo make uninstall
+       sudo make uninstall
 
-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.
+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.
 
-**THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT'S EMPTY, OTHERWISE**
+**THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT BECOMES EMPTY**
 
-    sudo make purge
+       sudo make purge
 
-**THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT'S EMPTY, OTHERWISE**
+**THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT BECOMES EMPTY**
 
 This is not in the default behaviour of `make uninstall` for obvious reasons.
 
@@ -29,8 +36,10 @@ This is not in the default behaviour of `make uninstall` for obvious reasons.
 
 To clean up the generated manpage, run
 
-    make clean
+       make clean
 
 and if you are bored, I suggest
 
-    make moo
+       make moo
+
+[1]: http://rtomayko.github.io/ronn/
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.