Sync docs
[tig] / README.html
index 8635164..ed44ed4 100644 (file)
@@ -1,36 +1,52 @@
+<div style="font-family: monospace;">\r
+<h1>Tig: text-mode interface for git</h1>\r
 <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
+from 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 revision 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
+<p>Using it as a pager, it will display input from stdin and colorize it.</p>\r
 </div>\r
 </div>\r
-<h2>Getting it</h2>\r
+<h2>Resources</h2>\r
 <div class="sectionbody">\r
-<p>To get tig either grab the Makefile and tig.c files from the home page:</p>\r
 <ul>\r
 <li>\r
 <p>\r
-<a href="http://jonas.nitro.dk/tig/">http://jonas.nitro.dk/tig/</a>\r
+Homepage:    <a href="http://jonas.nitro.dk/tig">http://jonas.nitro.dk/tig</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+Manual:      <a href="http://jonas.nitro.dk/tig/manual.html">http://jonas.nitro.dk/tig/manual.html</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+Releases:    <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+Git URL:     <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a> or\r
+                git://repo.or.cz/tig.git\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
+Gitweb:      <a href="http://repo.or.cz/?p=tig.git;a=summary">http://repo.or.cz/?p=tig.git;a=summary</a>\r
 </p>\r
 </li>\r
 </ul>\r
-<p>Documentation files are available either at the home page or in the above\r
-repository in the branch named <em>release</em>.</p>\r
 </div>\r
 <h2>Installation instructions</h2>\r
 <div class="sectionbody">\r
+<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
+repository <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a>. Documentation files are\r
+available either in the tarballs or in the above repository in the branch named\r
+<em>release</em>.</p>\r
 <p>To install tig simply run:</p>\r
 <div class="literalblock">\r
 <div class="content">\r
@@ -41,6 +57,10 @@ repository in the branch named <em>release</em>.</p>
 <div class="content">\r
 <pre><tt>$ make install-docs</tt></pre>\r
 </div></div>\r
+<p>Edit the Makefile if you need to configure specific compiler or linker flags.\r
+On FreeBSD for example the c library does not support the iconv interface and\r
+to compile tig you need to append <tt>-L/usr/local/lib -liconv</tt> to <tt>LDLIBS</tt> and\r
+<tt>-I/usr/local/include</tt> to the <tt>CFLAGS</tt> variable.</p>\r
 <p>The following tools and packages are needed:</p>\r
 <div class="tableblock">\r
 <table rules="none"\r
@@ -72,15 +92,15 @@ cellspacing="0" cellpadding="4">
     ncurses\r
     </td>\r
     <td align="left">\r
-    Be sure to also have development files                                 installed. Usually they are available in a\r
+    Be sure to also have development files                                 installed. Usually they are available in a                                 separate package ending with <tt>-dev</tt>.\r
     </td>\r
   </tr>\r
   <tr>\r
     <td align="left">\r
-    \r
+    iconv\r
     </td>\r
     <td align="left">\r
-    separate package ending with <tt>-dev</tt>.\r
+    If iconv is not provided by the c library                                 you need to change the Makefile to link it                                 into the binary.\r
     </td>\r
   </tr>\r
   <tr>\r
@@ -94,13 +114,5 @@ cellspacing="0" cellpadding="4">
 </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 tig(1) man page in order for the internal help to\r
-be available.</td>\r
-</tr></table>\r
 </div>\r
 </div>\r