Merge pull request #457 from vivien/text-variable
[tig.git] / README.adoc
blobfae03ff243f3ad8afe63d1017f810a0b84bb14ae
1 Tig: text-mode interface for Git
2 ================================
3 :docext: adoc
5 image:https://secure.travis-ci.org/jonas/tig.svg?branch=master[Build Status,link=http://travis-ci.org/jonas/tig]
6 image:https://badges.gitter.im/Join%20Chat.svg[Join Chat,link="https://gitter.im/jonas/tig?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
8 What is Tig?
9 ------------
10 Tig is an ncurses-based text-mode interface for git. It functions mainly
11 as a Git repository browser, but can also assist in staging changes for
12 commit at chunk level and act as a pager for output from various Git
13 commands.
15 Resources
16 ---------
18  - Homepage:    http://jonas.nitro.dk/tig/[]
19  - Manual:      http://jonas.nitro.dk/tig/manual.html[]
20  - Tarballs:    http://jonas.nitro.dk/tig/releases/[]
21  - Git URL:     git://github.com/jonas/tig.git (master) or
22                 git://repo.or.cz/tig.git (mirror)
23  - Gitter:      https://gitter.im/jonas/tig[]
24  - Q&A:         http://stackoverflow.com/questions/tagged/tig[]
26 Bugs and Feature Requests
27 -------------------------
28 Bugs and feature requests can be reported using the issue tracker at
29 https://github.com/jonas/tig/issues[] or by mail to either the Git mailing
30 list or directly to the maintainer. Ensure that the word "tig" is in the
31 subject. For other Tig related questions please use Stack Overflow:
32 http://stackoverflow.com/questions/tagged/tig[].
34 Installation and News
35 ---------------------
37 Information on how to build and install Tig are found in
38 link:INSTALL.{docext}[the installation instructions].
40 News about releases and latest features and bug fixes are found in
41 link:NEWS.{docext}[the release notes].