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

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