From: Richard Hartmann Date: Wed, 16 Nov 2011 20:39:20 +0000 (+0100) Subject: Actually commit new INSTALL.md X-Git-Url: https://git.madduck.net/code/vcsh.git/commitdiff_plain/129c9465800f6d89593312bb07efcd29c4fc2ea8?ds=sidebyside;hp=-c Actually commit new INSTALL.md --- 129c9465800f6d89593312bb07efcd29c4fc2ea8 diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..c69c010 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,36 @@ +# Pre-requisites # + +If you want to build the manpage, you will need ronn. Newer versions of Debian come with a package: + + apt-get install ruby-ronn + + +# 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'S EMPTY, OTHERWISE** + + sudo make purge + +**THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT'S EMPTY, OTHERWISE** + +This is not in the default behaviour of `make uninstall` for obvious reasons. + + +# Other stuff # + +To clean up the generated manpag, run + + make clean + +and if you are bored, I suggest + + make moo