From: Jonas Fonseca Date: Tue, 16 May 2006 15:20:28 +0000 (+0200) Subject: Add README.html X-Git-Url: https://git.distorted.org.uk/~mdw/tig/commitdiff_plain/fdcf8ca721aebceef3531e8558e6bf09f5e5549a Add README.html --- diff --git a/README.html b/README.html new file mode 100644 index 0000000..c3abc8b --- /dev/null +++ b/README.html @@ -0,0 +1,106 @@ +
+
+

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:

+ +

or clone the tig repository using the URL:

+ +

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