chiark / gitweb /
Merge with master
[tig] / README.html
1 <div style="font-family: monospace;">\r
2 <h1>Tig: text-mode interface for git</h1>\r
3 <div id="preamble">\r
4 <div class="sectionbody">\r
5 <p>Tig is a git repository browser that additionally can act as a pager for output\r
6 from various git commands.</p>\r
7 <p>When browsing repositories, it uses the underlying git commands to present the\r
8 user with various views, such as summarized revision log and showing the commit\r
9 with the log message, diffstat, and the diff.</p>\r
10 <p>Using it as a pager, it will display input from stdin and colorize it.</p>\r
11 </div>\r
12 </div>\r
13 <h2>Resources</h2>\r
14 <div class="sectionbody">\r
15 <ul>\r
16 <li>\r
17 <p>\r
18 Homepage: <a href="http://jonas.nitro.dk/tig">http://jonas.nitro.dk/tig</a>\r
19 </p>\r
20 </li>\r
21 <li>\r
22 <p>\r
23 Releases: <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a>\r
24 </p>\r
25 </li>\r
26 <li>\r
27 <p>\r
28 Git URL:  <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a>\r
29 </p>\r
30 </li>\r
31 <li>\r
32 <p>\r
33 Gitweb: <a href="http://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary">http://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary</a>\r
34 </p>\r
35 </li>\r
36 </ul>\r
37 </div>\r
38 <h2>Installation instructions</h2>\r
39 <div class="sectionbody">\r
40 <p>Download a tarball from <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a> or clone the tig\r
41 repository <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a>. Documentation files are\r
42 available either in the tarballs or in the above repository in the branch named\r
43 <em>release</em>.</p>\r
44 <p>To install tig simply run:</p>\r
45 <div class="literalblock">\r
46 <div class="content">\r
47 <pre><tt>$ make install</tt></pre>\r
48 </div></div>\r
49 <p>To install documentation run:</p>\r
50 <div class="literalblock">\r
51 <div class="content">\r
52 <pre><tt>$ make install-docs</tt></pre>\r
53 </div></div>\r
54 <p>The following tools and packages are needed:</p>\r
55 <div class="tableblock">\r
56 <table rules="none"\r
57 frame="hsides"\r
58 cellspacing="0" cellpadding="4">\r
59 <col width="365" />\r
60 <col width="537" />\r
61 <thead>\r
62   <tr>\r
63     <th align="left">\r
64     Tool\r
65     </th>\r
66     <th align="left">\r
67     Description\r
68     </th>\r
69   </tr>\r
70 </thead>\r
71 <tbody valign="top">\r
72   <tr>\r
73     <td align="left">\r
74     git-core\r
75     </td>\r
76     <td align="left">\r
77     Tig is just a frontend for git.\r
78     </td>\r
79   </tr>\r
80   <tr>\r
81     <td align="left">\r
82     ncurses\r
83     </td>\r
84     <td align="left">\r
85     Be sure to also have development files                                 installed. Usually they are available in a                                 separate package ending with <tt>-dev</tt>.\r
86     </td>\r
87   </tr>\r
88   <tr>\r
89     <td align="left">\r
90     asciidoc (&gt;= 7.0), xmlto\r
91     </td>\r
92     <td align="left">\r
93     For building documentation. (Optional)\r
94     </td>\r
95   </tr>\r
96 </tbody>\r
97 </table>\r
98 </div>\r
99 </div>\r
100 </div>\r