cgit Quick Facts
----------------

 * web interface ([cgi][]) for [Git][git] repositories, written in [C][]
 * licensed under [GPLv2][]
 * discussions, patches etc. go to the [list][] ([signup][], [archive][], [gmane][]).
 * common questions are answered in the [FAQ][faq].

[cgi]:     http://www.ietf.org/rfc/rfc3875.txt
[git]:     http://git-scm.org
[C]:       http://en.wikipedia.org/wiki/C_%28programming_language%29
[GPLv2]:   http://www.gnu.org/licenses/gpl-2.0.html
[list]:    mailto:cgit@lists.zx2c4.com
[signup]:  http://lists.zx2c4.com/mailman/listinfo/cgit
[archive]: http://lists.zx2c4.com/pipermail/cgit/
[gmane]:   http://dir.gmane.org/gmane.comp.version-control.cgit
[faq]:     faq

Features
--------
 * basic repository browsing (logs, diffs, trees...)
 * caching of generated HTML
 * cloneable URLs (implements dumb HTTP transport)
 * commit feeds (atom format)
 * discovery of Git repositories
 * on-the-fly archives for tags and commits
 * plugin support for e.g. syntax highlighting
 * side-by-side diffs
 * simple time/author statistics
 * simple virtual hosting support (macro expansion)
 * understands GitWeb project-lists
 * understands gitweb.owner in Git config files
 * has extensive filtering framework using scripts or a built-in lua interpreter

Source Code
-----------
 * download current or past [releases][]
 * clone the repo using the Git protocol:
   * git clone git://git.zx2c4.com/cgit
 * see the [README][] for build instructions

[releases]: /cgit/refs/tags
[README]:   /cgit/tree/README

Packages
--------
 * [Arch Linux][archlinux]
 * [Gentoo][gentoo]
 * [Fedora][fedora]
 * [OS X][macports]
 * [OpenSUSE][OpenSUSE]
 * [NetBSD][pkgsrc]

[archlinux]:    https://www.archlinux.org/packages/?name=cgit
[fedora]:       https://admin.fedoraproject.org/pkgdb/acls/name/cgit
[gentoo]:       http://packages.gentoo.org/package/www-apps/cgit
[macports]:     http://trac.macports.org/browser/trunk/dports/www/cgit
[opensuse]:     https://build.opensuse.org/package/show?package=cgit&project=devel%3Atools%3Ascm
[pkgsrc]:       http://pkgsrc.se/wip/cgit