X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/11c9cad0dd844a76d03fdd16ea47fb28b6e87b57..refs/heads/release:/README.html diff --git a/README.html b/README.html index 58dd334..ed44ed4 100644 --- a/README.html +++ b/README.html @@ -1,36 +1,52 @@ +
+

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.

+from 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 +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 try to colorize it.

+

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

-

Getting it

+

Resources

-

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

-

or clone the tig repository using the URL:

- -

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

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:

@@ -41,6 +57,10 @@ repository in the branch named release.

$ make install-docs
+

Edit the Makefile if you need to configure specific compiler or linker flags. +On FreeBSD for example the c library does not support the iconv interface and +to compile tig you need to append -L/usr/local/lib -liconv to LDLIBS and +-I/usr/local/include to the CFLAGS variable.

The following tools and packages are needed:

ncurses @@ -94,13 +114,5 @@ cellspacing="0" cellpadding="4">
- Be sure to also have development files installed. Usually they are available in a + Be sure to also have development files installed. Usually they are available in a separate package ending with -dev.
- + iconv - separate package ending with -dev. + If iconv is not provided by the c library you need to change the Makefile to link it into the binary.
-
- - - -
-
Note
-		You need to install the tig(1) man page in order for the internal help to -be available.