![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index c0ba9991331c5480f2586260164e32af82175fd9..7759326a5d1dfc4b1da564ca43a306169842e5e8 100644 (file)
--- a/INSTALL
+++ b/INSTALL
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:
+
+ $ ./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-docs
+ $ make configure
+
+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:
-------------------------------------------------------------------------------
git-core Tig is just a frontend for git.
ncurses Be sure to also have development files \
- installed. Usually they are available in a
+ installed. Usually they are available in a \
separate package ending with `-dev`.
-asciidoc (>= 7.0), xmlto For building documentation. (Optional)
+iconv If iconv is not provided by the c library \
+ you need to change the Makefile to link it \
+ into the binary.
+-------------------------------------------------------------------------------
+
+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.
-------------------------------------------------------------------------------