mdw@git.distorted.org.uk Git - tig/blob - README.html

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