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