Merge git://ozlabs.org/~paulus/gitk
[git.git] / README.md
blob88f126184c52bfe4859ec189d018872902e02a84
1 [![Build Status](https://dev.azure.com/git/git/_apis/build/status/git.git)](https://dev.azure.com/git/git/_build/latest?definitionId=11)
3 Git - fast, scalable, distributed revision control system
4 =========================================================
6 Git is a fast, scalable, distributed revision control system with an
7 unusually rich command set that provides both high-level operations
8 and full access to internals.
10 Git is an Open Source project covered by the GNU General Public
11 License version 2 (some parts of it are under different licenses,
12 compatible with the GPLv2). It was originally written by Linus
13 Torvalds with help of a group of hackers around the net.
15 Please read the file [INSTALL][] for installation instructions.
17 Many Git online resources are accessible from <https://git-scm.com/>
18 including full documentation and Git related tools.
20 See [Documentation/gittutorial.txt][] to get started, then see
21 [Documentation/giteveryday.txt][] for a useful minimum set of commands, and
22 Documentation/git-<commandname>.txt for documentation of each command.
23 If git has been correctly installed, then the tutorial can also be
24 read with `man gittutorial` or `git help tutorial`, and the
25 documentation of each command with `man git-<commandname>` or `git help
26 <commandname>`.
28 CVS users may also want to read [Documentation/gitcvs-migration.txt][]
29 (`man gitcvs-migration` or `git help cvs-migration` if git is
30 installed).
32 The user discussion and development of Git take place on the Git
33 mailing list -- everyone is welcome to post bug reports, feature
34 requests, comments and patches to git@vger.kernel.org (read
35 [Documentation/SubmittingPatches][] for instructions on patch submission).
36 To subscribe to the list, send an email with just "subscribe git" in
37 the body to majordomo@vger.kernel.org. The mailing list archives are
38 available at <https://public-inbox.org/git/>,
39 <http://marc.info/?l=git> and other archival sites.
41 Issues which are security relevant should be disclosed privately to
42 the Git Security mailing list <git-security@googlegroups.com>.
44 The maintainer frequently sends the "What's cooking" reports that
45 list the current status of various development topics to the mailing
46 list.  The discussion following them give a good reference for
47 project status, development direction and remaining tasks.
49 The name "git" was given by Linus Torvalds when he wrote the very
50 first version. He described the tool as "the stupid content tracker"
51 and the name as (depending on your mood):
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
62 [INSTALL]: INSTALL
63 [Documentation/gittutorial.txt]: Documentation/gittutorial.txt
64 [Documentation/giteveryday.txt]: Documentation/giteveryday.txt
65 [Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
66 [Documentation/SubmittingPatches]: Documentation/SubmittingPatches