X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=INSTALL;h=7759326a5d1dfc4b1da564ca43a306169842e5e8;hb=bb9a850a77f85331a151141907b0bae72263fa82;hp=2a4d2e1244a46fc0999bf14f717758df7c43e4c1;hpb=26a7f2718350bda0367b97d75fbc3627d4ad2a6f;p=tig.git diff --git a/INSTALL b/INSTALL index 2a4d2e1..7759326 100644 --- a/INSTALL +++ b/INSTALL @@ -3,21 +3,29 @@ Installation instructions Download a tarball from http://jonas.nitro.dk/tig/releases[] or clone the tig repository http://jonas.nitro.dk/tig/tig.git[]. Documentation files are -available either in the tarballs or in the above repository in the branch named -'release'. +available in the tarballs and in the 'release' branch of the tig repository. -To install tig simply run: +The quick and simple way to install tig with documentation is to run: + + $ make + $ make install install-doc + +Optionally, you can use the `configure` script to detect library location: - $ autoreconf $ ./configure + $ make $ make install -To install documentation run: +If your iconv library is not in the default library and include path, you'll +probably want to pass the "--with-libiconv" option to the "configure" script to +tell it where to look. Note, if you are building from the tig repository, you +need to first make the configure script: - $ make install-doc + $ make configure -If you had to install your own copy of libiconv, you'll probably want to pass -the "--with-libiconv" option to the "configure" script to tell it where to look. +Release notes documenting notable changes are available in the NEWS file. When +upgrading, you are advised to also read them after you have completed the +installation. The following tools and packages are needed: @@ -31,5 +39,17 @@ ncurses Be sure to also have development files \ iconv If iconv is not provided by the c library \ you need to change the Makefile to link it \ into the binary. -asciidoc (>= 7.0), xmlto For building documentation. (Optional) +------------------------------------------------------------------------------- + +The following optional tools and packages are needed for creating the +configure script and building documentation: + +`-------------------------------`---------------------------------------------- +autoconf Contains autoreconf for generating configure \ + from configure.ac. +asciidoc (>= 8.0) Generates HTML and (DocBook) XML from text. +xmlto Generates manpages and chunked HTML from XML. +DocBook XSL (>= 1.72.0) Used by xmlto for building manpages. +DocBook (DSSL/Jade) tools Generates PDF from XML. \ + Also known as docbook-utils. -------------------------------------------------------------------------------