doc/INSTALL.md

   1 # Pre-requisites #
   2
   3 If you want to build the manpage, you will need [ronn] [1].
   4 Debian 7.0 and above come with a package, so do most Debian clones.
   5
   6 To install ronn on your Debian-based system, simply run
   7
   8         apt-get install ruby-ronn
   9
  10 There are no other dependencies other than `git`, `ronn` and a POSIX shell.
  11
  12
  13 # Installing #
  14
  15         sudo make install
  16
  17
  18 # Uninstalling #
  19
  20         sudo make uninstall
  21
  22 There is another, more thorough, version. Just make sure you are not running
  23 this when you have installed to an important directory which is empty,
  24 otherwise.
  25
  26 **THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT BECOMES EMPTY**
  27
  28         sudo make purge
  29
  30 **THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT BECOMES EMPTY**
  31
  32 This is not in the default behaviour of `make uninstall` for obvious reasons.
  33
  34
  35 # Other stuff #
  36
  37 To clean up the generated manpage, run
  38
  39         make clean
  40
  41 and if you are bored, I suggest
  42
  43         make moo
  44
  45 [1]: http://rtomayko.github.io/ronn/