Move stuff to BUGS and TODO files; only show BUGS in tig(1)

[tig] / README

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

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

When browsing repositories, it uses the underlying git commands to present the
user with various views, such as summarized revision 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 colorize it.

Resources
---------

 - Homepage: http://jonas.nitro.dk/tig[]
 - Releases: http://jonas.nitro.dk/tig/releases[]
 - Git URL:  http://jonas.nitro.dk/tig/tig.git[]
 - Gitweb: http://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary[]

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'.

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 tig(1) man page in order for the internal help to
be available.