cgit/index
Jason A. Donenfeld 64ebbcaf44 Mention IRC
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
2021-06-08 15:16:47 +02:00

62 lines
2.0 KiB
Plaintext

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][]).
* real time chat available in #cgit on Libera.Chat.
* common questions are answered in the [FAQ][faq].
[cgi]: https://tools.ietf.org/html/rfc3875
[git]: https://git-scm.com/
[C]: https://en.wikipedia.org/wiki/C_%28programming_language%29
[GPLv2]: https://www.gnu.org/licenses/gpl-2.0.html
[list]: mailto:cgit@lists.zx2c4.com
[signup]: https://lists.zx2c4.com/mailman/listinfo/cgit
[archive]: https://lists.zx2c4.com/pipermail/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:
* git clone https://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/RHEL/CentOS][fedora]
* [OS X][macports]
* [OpenSUSE][OpenSUSE]
* [NetBSD][pkgsrc]
* [FreeBSD][freshports]
[archlinux]: https://www.archlinux.org/packages/?name=cgit
[fedora]: https://apps.fedoraproject.org/packages/cgit
[gentoo]: https://packages.gentoo.org/packages/www-apps/cgit
[macports]: https://trac.macports.org/browser/trunk/dports/www/cgit
[opensuse]: https://software.opensuse.org/package/cgit
[pkgsrc]: http://pkgsrc.se/www/cgit
[freshports]: https://www.freshports.org/devel/cgit/