X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/b5eeff5aca19d4ddcaa4a1cdd427e9eb7d86c6a4..afdc35b3c4038d52405302058e70a78e88f01c89:/README diff --git a/README b/README index 70456aa..5304ca4 100644 --- a/README +++ b/README @@ -2,31 +2,30 @@ 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 tig ------------ +Resources +--------- -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 'release'. + - 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 @@ -47,5 +46,5 @@ ncurses Be sure to also have development files \ asciidoc (>= 7.0), xmlto For building documentation. (Optional) ------------------------------------------------------------------------------- -NOTE: You need to install the documentation for the internal help to be -available. +NOTE: You need to install the tig(1) man page in order for the internal help to +be available.