1cgit Quick Facts
 2----------------
 3
 4 * web interface ([cgi][]) for [Git][git] repositories, written in [C][]
 5 * licensed under [GPLv2][]
 6 * discussions, patches etc. go to the [list][] ([signup][], [archive][], [gmane][]).
 7 * common questions are answered in the [FAQ][faq].
 8
 9[cgi]:     http://www.ietf.org/rfc/rfc3875.txt
10[git]:     http://git-scm.org
11[C]:       http://en.wikipedia.org/wiki/C_%28programming_language%29
12[GPLv2]:   http://www.gnu.org/licenses/gpl-2.0.html
13[list]:    mailto:cgit@lists.zx2c4.com
14[signup]:  http://lists.zx2c4.com/mailman/listinfo/cgit
15[archive]: http://lists.zx2c4.com/pipermail/cgit/
16[gmane]:   http://dir.gmane.org/gmane.comp.version-control.cgit
17[faq]:     faq
18
19Features
20--------
21 * basic repository browsing (logs, diffs, trees...)
22 * caching of generated HTML
23 * cloneable URLs (implements dumb HTTP transport)
24 * commit feeds (atom format)
25 * discovery of Git repositories
26 * on-the-fly archives for tags and commits
27 * plugin support for e.g. syntax highlighting
28 * side-by-side diffs
29 * simple time/author statistics
30 * simple virtual hosting support (macro expansion)
31 * understands GitWeb project-lists
32 * understands gitweb.owner in Git config files
33 * has extensive filtering framework using scripts or a built-in lua interpreter
34
35Source Code
36-----------
37 * download current or past [releases][]
38 * clone the repo using the Git protocol:
39   * git clone git://git.zx2c4.com/cgit
40 * see the [README][] for build instructions
41
42[releases]: /cgit/refs/tags
43[README]:   /cgit/tree/README
44
45Packages
46--------
47 * [Arch Linux][archlinux]
48 * [Gentoo][gentoo]
49 * [Fedora][fedora]
50 * [OS X][macports]
51 * [OpenSUSE][OpenSUSE]
52 * [NetBSD][pkgsrc]
53
54[archlinux]:    https://www.archlinux.org/packages/?name=cgit
55[fedora]:       https://admin.fedoraproject.org/pkgdb/acls/name/cgit
56[gentoo]:       http://packages.gentoo.org/package/www-apps/cgit
57[macports]:     http://trac.macports.org/browser/trunk/dports/www/cgit
58[opensuse]:     https://build.opensuse.org/package/show?package=cgit&project=devel%3Atools%3Ascm
59[pkgsrc]:       http://pkgsrc.se/wip/cgit