You gotta have a README file
[tig] / README
1 Tig: text-mode interface for git
2 ================================
3
4 Tig is a git repository browser that additionally can act as a pager for output
5 of various git commands.
6
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.
10
11 Using it as a pager, it will display input from stdin and try to colorize it.
12
13 Getting tig
14 -----------
15
16 To get tig either grab the Makefile and tig.c files from the tig home page:
17
18  - http://jonas.nitro.dk/tig/[]
19
20 or clone the tig repository using the URL:
21
22  - http://jonas.nitro.dk/tig/tig.git[]
23
24 Documentation files are available either at the home page or or in the above
25 repository in the branch named 'docs'.
26
27 Installation instructions
28 -------------------------
29
30 To install tig simply run:
31
32         $ make install
33
34 To install documentation run:
35
36         $ make install-docs
37
38 The following tools and packages are needed:
39
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 -------------------------------------------------------------------------------
49
50 NOTE: You need to install the documentation for the internal help to be
51 available.