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 ## Installing without root privileges ##
  18
  19         make install DESTDIR=/home/myuser/local
  20
  21 or simply copy the shell script into any place you like, e.g. `~/bin`
  22
  23
  24 # Uninstalling #
  25
  26         sudo make uninstall
  27
  28 There is another, more thorough, version. Just make sure you are not running
  29 this when you have installed to an important directory which is empty,
  30 otherwise.
  31
  32 **THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT BECOMES EMPTY**
  33
  34         sudo make purge
  35
  36 **THIS WILL DELETE /usr/local IF YOU INSTALLED THERE AND IT BECOMES EMPTY**
  37
  38 This is not in the default behaviour of `make uninstall` for obvious reasons.
  39
  40
  41 # Other stuff #
  42
  43 To clean up the generated manpage, run
  44
  45         make clean
  46
  47 and if you are bored, I suggest
  48
  49         make moo
  50
  51 [1]: http://rtomayko.github.io/ronn/