Document the test framework and improve the test output
[tig.git] / README.adoc
blob5ff9e1be61020b7c578a534a29702fd603e9236f
1 Tig: text-mode interface for Git
2 ================================
3 :docext: adoc
5 image::https://secure.travis-ci.org/jonas/tig.png?branch=master[Build Status,link=http://travis-ci.org/jonas/tig]
7 What is Tig?
8 ------------
9 Tig is an ncurses-based text-mode interface for git. It functions mainly
10 as a Git repository browser, but can also assist in staging changes for
11 commit at chunk level and act as a pager for output from various Git
12 commands.
14 Resources
15 ---------
17  - Homepage:    http://jonas.nitro.dk/tig/[]
18  - Manual:      http://jonas.nitro.dk/tig/manual.html[]
19  - Tarballs:    http://jonas.nitro.dk/tig/releases/[]
20  - Git URL:     git://github.com/jonas/tig.git (master) or
21                 git://repo.or.cz/tig.git (mirror)
22  - Gitweb:      http://repo.or.cz/w/tig.git[]
23  - Q&A:         http://stackoverflow.com/questions/tagged/tig[]
25 Bugs and Feature Requests
26 -------------------------
27 Bugs and feature requests can be reported using the issue tracker at
28 https://github.com/jonas/tig/issues[] or by mail to either the Git mailing
29 list or directly to the maintainer. Ensure that the word "tig" is in the
30 subject. For other Tig related questions please use Stack Overflow:
31 http://stackoverflow.com/questions/tagged/tig[].
33 Installation and News
34 ---------------------
36 Information on how to build and install Tig are found in
37 link:INSTALL.{docext}[the installation instructions].
39 News about releases and latest features and bug fixes are found in
40 link:NEWS.{docext}[the release notes].