Add README.html
authorJonas Fonseca <fonseca@diku.dk>
Tue, 16 May 2006 15:20:28 +0000 (17:20 +0200)
committerJonas Fonseca <fonseca@antimatter.localdomain>
Tue, 16 May 2006 15:20:28 +0000 (17:20 +0200)
README.html [new file with mode: 0644]

diff --git a/README.html b/README.html
new file mode 100644 (file)
index 0000000..c3abc8b
--- /dev/null
@@ -0,0 +1,106 @@
+<div id="preamble">\r
+<div class="sectionbody">\r
+<p>Tig is a git repository browser that additionally can act as a pager for output\r
+of various git commands.</p>\r
+<p>When browsing repositories, it uses the underlying git commands to present the\r
+user with various views, such as summarized commit log and showing the commit\r
+with the log message, diffstat, and the diff.</p>\r
+<p>Using it as a pager, it will display input from stdin and try to colorize it.</p>\r
+</div>\r
+</div>\r
+<h2>Getting tig</h2>\r
+<div class="sectionbody">\r
+<p>To get tig either grab the Makefile and tig.c files from the tig home page:</p>\r
+<ul>\r
+<li>\r
+<p>\r
+<a href="http://jonas.nitro.dk/tig/">http://jonas.nitro.dk/tig/</a>\r
+</p>\r
+</li>\r
+</ul>\r
+<p>or clone the tig repository using the URL:</p>\r
+<ul>\r
+<li>\r
+<p>\r
+<a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a>\r
+</p>\r
+</li>\r
+</ul>\r
+<p>Documentation files are available either at the home page or or in the above\r
+repository in the branch named <em>docs</em>.</p>\r
+</div>\r
+<h2>Installation instructions</h2>\r
+<div class="sectionbody">\r
+<p>To install tig simply run:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>$ make install</tt></pre>\r
+</div></div>\r
+<p>To install documentation run:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>$ make install-docs</tt></pre>\r
+</div></div>\r
+<p>The following tools and packages are needed:</p>\r
+<div class="tableblock">\r
+<table rules="none"\r
+frame="hsides"\r
+cellspacing="0" cellpadding="4">\r
+<col width="365" />\r
+<col width="537" />\r
+<thead>\r
+  <tr>\r
+    <th align="left">\r
+    Tool\r
+    </th>\r
+    <th align="left">\r
+    Description\r
+    </th>\r
+  </tr>\r
+</thead>\r
+<tbody valign="top">\r
+  <tr>\r
+    <td align="left">\r
+    git-core\r
+    </td>\r
+    <td align="left">\r
+    Tig is just a frontend for git.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    ncurses\r
+    </td>\r
+    <td align="left">\r
+    Be sure to also have development files                                 installed. Usually they are available in a\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    \r
+    </td>\r
+    <td align="left">\r
+    separate package ending with <tt>-dev</tt>.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    asciidoc (&gt;= 7.0), xmlto\r
+    </td>\r
+    <td align="left">\r
+    For building documentation. (Optional)\r
+    </td>\r
+  </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+<div class="admonitionblock">\r
+<table><tr>\r
+<td class="icon">\r
+<div class="title">Note</div>\r
+</td>\r
+<td class="content">You need to install the documentation for the internal help to be\r
+available.</td>\r
+</tr></table>\r
+</div>\r
+</div>\r