After seeing Linus' mail further improve revision specification section
[tig] / README
CommitLineData
b8ae9346
JF
1Tig: text-mode interface for git
2================================
3
4Tig is a git repository browser that additionally can act as a pager for output
5of various git commands.
6
7When browsing repositories, it uses the underlying git commands to present the
8user with various views, such as summarized commit log and showing the commit
9with the log message, diffstat, and the diff.
10
11Using it as a pager, it will display input from stdin and try to colorize it.
12
e271cee0
JF
13Getting it
14----------
b8ae9346 15
e271cee0 16To get tig either grab the Makefile and tig.c files from the home page:
b8ae9346
JF
17
18 - http://jonas.nitro.dk/tig/[]
19
20or clone the tig repository using the URL:
21
22 - http://jonas.nitro.dk/tig/tig.git[]
23
e271cee0 24Documentation files are available either at the home page or in the above
b5eeff5a 25repository in the branch named 'release'.
b8ae9346
JF
26
27Installation instructions
28-------------------------
29
30To install tig simply run:
31
32 $ make install
33
34To install documentation run:
35
36 $ make install-docs
37
38The following tools and packages are needed:
39
40`-------------------------------`----------------------------------------------
41Tool Description
42-------------------------------------------------------------------------------
43git-core Tig is just a frontend for git.
44ncurses Be sure to also have development files \
45 installed. Usually they are available in a
46 separate package ending with `-dev`.
47asciidoc (>= 7.0), xmlto For building documentation. (Optional)
48-------------------------------------------------------------------------------
49
06f9a9e1
JF
50NOTE: You need to install the tig(1) man page in order for the internal help to
51be available.