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

   1 Tig: text-mode interface for git
   2 ================================
   3
   4 Tig is a git repository browser that additionally can act as a pager for output
   5 from various git commands.
   6
   7 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.
  10
  11 Using it as a pager, it will display input from stdin and colorize it.
  12
  13 Resources
  14 ---------
  15
  16  - Homepage: http://jonas.nitro.dk/tig[]
  17  - Releases: http://jonas.nitro.dk/tig/releases[]
  18  - Git URL:  http://jonas.nitro.dk/tig/tig.git[]
  19  - Gitweb: http://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary[]
  20
  21 Installation instructions
  22 -------------------------
  23
  24 Download a tarball from http://jonas.nitro.dk/tig/releases[] or clone the tig
  25 repository http://jonas.nitro.dk/tig/tig.git[]. Documentation files are
  26 available either in the tarballs or in the above repository in the branch named
  27 'release'.
  28
  29 To install tig simply run:
  30
  31         $ make install
  32
  33 To install documentation run:
  34
  35         $ make install-docs
  36
  37 The following tools and packages are needed:
  38
  39 `-------------------------------`----------------------------------------------
  40 Tool                            Description
  41 -------------------------------------------------------------------------------
  42 git-core                        Tig is just a frontend for git.
  43 ncurses                         Be sure to also have development files \
  44                                 installed. Usually they are available in a
  45                                 separate package ending with `-dev`.
  46 asciidoc (>= 7.0), xmlto        For building documentation. (Optional)
  47 -------------------------------------------------------------------------------
  48
  49 NOTE: You need to install the tig(1) man page in order for the internal help to
  50 be available.