Move docs to doc/

[code/vcsh.git] / doc / INSTALL.md

diff --git a/doc/INSTALL.md b/doc/INSTALL.md
new file mode 100644 (file)
index 0000000..29c9889
--- /dev/null
+++ b/doc/INSTALL.md
@@ -0,0 +1,45 @@
+# Pre-requisites #
+
+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.
+
+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
+
+
+# Uninstalling #
+
+       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.
+
+**THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT BECOMES EMPTY**
+
+       sudo make purge
+
+**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.
+
+
+# Other stuff #
+
+To clean up the generated manpage, run
+
+       make clean
+
+and if you are bored, I suggest
+
+       make moo
+
+[1]: http://rtomayko.github.io/ronn/