INSTALL

   1 Installation instructions
   2 -------------------------
   3
   4 Download a tarball from http://jonas.nitro.dk/tig/releases[] or clone the tig
   5 repository http://jonas.nitro.dk/tig/tig.git[]. Documentation files are
   6 available in the tarballs and in the 'release' branch of the tig repository.
   7
   8 The quick and simple way to install tig with documentation is to run:
   9
  10         $ make
  11         $ make install install-doc
  12
  13 Optionally, you can use the `configure` script to detect library location:
  14
  15         $ ./configure
  16         $ make
  17         $ make install
  18
  19 If your iconv library is not in the default library and include path, you'll
  20 probably want to pass the "--with-libiconv" option to the "configure" script to
  21 tell it where to look. Note, if you are building from the tig repository, you
  22 need to first make the configure script:
  23
  24         $ make configure
  25
  26 Release notes documenting notable changes are available in the NEWS file. When
  27 upgrading, you are adviced to also read them after you have completed the
  28 installation.
  29
  30 The following tools and packages are needed:
  31
  32 `-------------------------------`----------------------------------------------
  33 Tool                            Description
  34 -------------------------------------------------------------------------------
  35 git-core                        Tig is just a frontend for git.
  36 ncurses                         Be sure to also have development files \
  37                                 installed. Usually they are available in a \
  38                                 separate package ending with `-dev`.
  39 iconv                           If iconv is not provided by the c library \
  40                                 you need to change the Makefile to link it \
  41                                 into the binary.
  42 -------------------------------------------------------------------------------
  43
  44 The following optional tools and packages are needed for creating the
  45 configure script and building documentation:
  46
  47 `-------------------------------`----------------------------------------------
  48 autoconf                        Contains autoreconf for generating configure \
  49                                 from configure.ac.
  50 asciidoc (>= 8.0)               Generates HTML and (DocBook) XML from text.
  51 xmlto                           Generates manpages and chunked HTML from XML.
  52 DocBook XSL (>= 1.72.0)         Used by xmlto for building manpages.
  53 DocBook (DSSL/Jade) tools       Generates PDF from XML. \
  54                                 Also known as docbook-utils.
  55 -------------------------------------------------------------------------------