Merge branch 'ma/asciidoctor-more-fixes'
[git/git.git] / README.md
CommitLineData
39ffebd2 1[![Build Status](https://dev.azure.com/git/git/_apis/build/status/git.git)](https://dev.azure.com/git/git/_build/latest?definitionId=11)
5f786466 2
28513c4f
MM
3Git - fast, scalable, distributed revision control system
4=========================================================
556b6600 5
556b6600
NP
6Git is a fast, scalable, distributed revision control system with an
7unusually rich command set that provides both high-level operations
8and full access to internals.
9
779d7e93
SL
10Git is an Open Source project covered by the GNU General Public
11License version 2 (some parts of it are under different licenses,
71ce415d
JH
12compatible with the GPLv2). It was originally written by Linus
13Torvalds with help of a group of hackers around the net.
556b6600 14
61649720 15Please read the file [INSTALL][] for installation instructions.
aa98eb3d 16
bcd886d8 17Many Git online resources are accessible from <https://git-scm.com/>
d9b297db
MM
18including full documentation and Git related tools.
19
61649720
MM
20See [Documentation/gittutorial.txt][] to get started, then see
21[Documentation/giteveryday.txt][] for a useful minimum set of commands, and
7926cee9 22`Documentation/git-<commandname>.txt` for documentation of each command.
aa98eb3d 23If git has been correctly installed, then the tutorial can also be
a299e3a3
BD
24read with `man gittutorial` or `git help tutorial`, and the
25documentation of each command with `man git-<commandname>` or `git help
26<commandname>`.
aa98eb3d 27
61649720 28CVS users may also want to read [Documentation/gitcvs-migration.txt][]
a299e3a3 29(`man gitcvs-migration` or `git help cvs-migration` if git is
aa98eb3d 30installed).
556b6600 31
556b6600
NP
32The user discussion and development of Git take place on the Git
33mailing list -- everyone is welcome to post bug reports, feature
07f050c9 34requests, comments and patches to git@vger.kernel.org (read
61649720 35[Documentation/SubmittingPatches][] for instructions on patch submission).
07f050c9
MM
36To subscribe to the list, send an email with just "subscribe git" in
37the body to majordomo@vger.kernel.org. The mailing list archives are
bcd886d8
EW
38available at <https://public-inbox.org/git/>,
39<http://marc.info/?l=git> and other archival sites.
33b29fd1 40
2a00502b
TG
41Issues which are security relevant should be disclosed privately to
42the Git Security mailing list <git-security@googlegroups.com>.
43
33b29fd1
JH
44The maintainer frequently sends the "What's cooking" reports that
45list the current status of various development topics to the mailing
46list. The discussion following them give a good reference for
47project status, development direction and remaining tasks.
61649720 48
a217f073
MM
49The name "git" was given by Linus Torvalds when he wrote the very
50first version. He described the tool as "the stupid content tracker"
51and the name as (depending on your mood):
52
53 - random three-letter combination that is pronounceable, and not
54 actually used by any common UNIX command. The fact that it is a
55 mispronunciation of "get" may or may not be relevant.
56 - stupid. contemptible and despicable. simple. Take your pick from the
57 dictionary of slang.
58 - "global information tracker": you're in a good mood, and it actually
59 works for you. Angels sing, and a light suddenly fills the room.
60 - "goddamn idiotic truckload of sh*t": when it breaks
61
61649720
MM
62[INSTALL]: INSTALL
63[Documentation/gittutorial.txt]: Documentation/gittutorial.txt
64[Documentation/giteveryday.txt]: Documentation/giteveryday.txt
61649720
MM
65[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
66[Documentation/SubmittingPatches]: Documentation/SubmittingPatches