Merge with master
[tig] / README.html
CommitLineData
3ad8214b
JF
1<div style="font-family: sans-serif;">\r
2<h1>Tig: text-mode interface for git</h1>\r
fdcf8ca7
JF
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
3ad8214b 6from various git commands.</p>\r
fdcf8ca7 7<p>When browsing repositories, it uses the underlying git commands to present the\r
56235576 8user with various views, such as summarized revision log and showing the commit\r
fdcf8ca7 9with the log message, diffstat, and the diff.</p>\r
3ad8214b 10<p>Using it as a pager, it will display input from stdin and colorize it.</p>\r
fdcf8ca7
JF
11</div>\r
12</div>\r
3ad8214b 13<h2>Resources</h2>\r
fdcf8ca7 14<div class="sectionbody">\r
fdcf8ca7
JF
15<ul>\r
16<li>\r
17<p>\r
3ad8214b
JF
18Homepage: <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
23Releases: <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a>\r
fdcf8ca7
JF
24</p>\r
25</li>\r
fdcf8ca7
JF
26<li>\r
27<p>\r
3ad8214b
JF
28Git 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
33Gitweb: <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
fdcf8ca7
JF
34</p>\r
35</li>\r
36</ul>\r
fdcf8ca7
JF
37</div>\r
38<h2>Installation instructions</h2>\r
39<div class="sectionbody">\r
3ad8214b
JF
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
41repository <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a>. Documentation files are\r
42available either in the tarballs or in the above repository in the branch named\r
43<em>release</em>.</p>\r
fdcf8ca7
JF
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
57frame="hsides"\r
58cellspacing="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\r
86 </td>\r
87 </tr>\r
88 <tr>\r
89 <td align="left">\r
90 \r
91 </td>\r
92 <td align="left">\r
93 separate package ending with <tt>-dev</tt>.\r
94 </td>\r
95 </tr>\r
96 <tr>\r
97 <td align="left">\r
98 asciidoc (&gt;= 7.0), xmlto\r
99 </td>\r
100 <td align="left">\r
101 For building documentation. (Optional)\r
102 </td>\r
103 </tr>\r
104</tbody>\r
105</table>\r
106</div>\r
fdcf8ca7 107</div>\r
3ad8214b 108</div>\r