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