mdw@git.distorted.org.uk Git - tig/blob - 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 The following tools and packages are needed:
  27
  28 `-------------------------------`----------------------------------------------
  29 Tool                            Description
  30 -------------------------------------------------------------------------------
  31 git-core                        Tig is just a frontend for git.
  32 ncurses                         Be sure to also have development files \
  33                                 installed. Usually they are available in a \
  34                                 separate package ending with `-dev`.
  35 iconv                           If iconv is not provided by the c library \
  36                                 you need to change the Makefile to link it \
  37                                 into the binary.
  38 -------------------------------------------------------------------------------
  39
  40 The following optional tools and packages are needed for creating the
  41 configure script and building documentation:
  42
  43 `-------------------------------`----------------------------------------------
  44 autoconf                        Contains autoreconf for generating configure \
  45                                 from configure.ac.
  46 asciidoc (>= 8.0)               Generates HTML and (DocBook) XML from text.
  47 xmlto                           Generates manpages and chunked HTML from XML.
  48 DocBook XSL (>= 1.72.0)         Used by xmlto for building manpages.
  49 DocBook (DSSL/Jade) tools       Generates PDF from XML. \
  50                                 Also known as docbook-utils.
  51 -------------------------------------------------------------------------------