Code

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