X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/129c9465800f6d89593312bb07efcd29c4fc2ea8..20e3b19c49f00cc18ad6b468c4a19a4b4275d30d:/INSTALL.md diff --git a/INSTALL.md b/INSTALL.md index c69c010..29c9889 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,36 +1,45 @@ # 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. # Other stuff # -To clean up the generated manpag, run +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/