You gotta have a README file

[tig] / README

Tig: text-mode interface for git
================================

Tig is a git repository browser that additionally can act as a pager for output
of various git commands.

When browsing repositories, it uses the underlying git commands to present the
user with various views, such as summarized commit log and showing the commit
with the log message, diffstat, and the diff.

Using it as a pager, it will display input from stdin and try to colorize it.

Getting tig
-----------

To get tig either grab the Makefile and tig.c files from the tig home page:

 - http://jonas.nitro.dk/tig/[]

or clone the tig repository using the URL:

 - http://jonas.nitro.dk/tig/tig.git[]

Documentation files are available either at the home page or or in the above
repository in the branch named 'docs'.

Installation instructions
-------------------------

To install tig simply run:

	$ make install

To install documentation run:

	$ make install-docs

The following tools and packages are needed:

`-------------------------------`----------------------------------------------
Tool				Description
-------------------------------------------------------------------------------
git-core			Tig is just a frontend for git.
ncurses				Be sure to also have development files \
				installed. Usually they are available in a
				separate package ending with `-dev`.
asciidoc (>= 7.0), xmlto	For building documentation. (Optional)
-------------------------------------------------------------------------------

NOTE: You need to install the documentation for the internal help to be
available.