Final batch before 2.9-rc1
[git/git.git] / README.md
CommitLineData
28513c4f
MM
1Git - fast, scalable, distributed revision control system
2=========================================================
556b6600 3
556b6600
NP
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
779d7e93
SL
8Git is an Open Source project covered by the GNU General Public
9License version 2 (some parts of it are under different licenses,
71ce415d
JH
10compatible with the GPLv2). It was originally written by Linus
11Torvalds with help of a group of hackers around the net.
556b6600 12
61649720 13Please read the file [INSTALL][] for installation instructions.
aa98eb3d 14
d9b297db
MM
15Many Git online resources are accessible from http://git-scm.com/
16including full documentation and Git related tools.
17
61649720
MM
18See [Documentation/gittutorial.txt][] to get started, then see
19[Documentation/giteveryday.txt][] for a useful minimum set of commands, and
c9a014e3 20Documentation/git-*commandname*.txt for documentation of each command.
aa98eb3d
CC
21If git has been correctly installed, then the tutorial can also be
22read with "man gittutorial" or "git help tutorial", and the
c9a014e3
MM
23documentation of each command with "man git-*commandname*" or "git help
24*commandname*".
aa98eb3d 25
61649720 26CVS users may also want to read [Documentation/gitcvs-migration.txt][]
aa98eb3d
CC
27("man gitcvs-migration" or "git help cvs-migration" if git is
28installed).
556b6600 29
556b6600
NP
30The user discussion and development of Git take place on the Git
31mailing list -- everyone is welcome to post bug reports, feature
07f050c9 32requests, comments and patches to git@vger.kernel.org (read
61649720 33[Documentation/SubmittingPatches][] for instructions on patch submission).
07f050c9
MM
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
33b29fd1
JH
36available at http://news.gmane.org/gmane.comp.version-control.git/,
37http://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.
61649720 43
a217f073
MM
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
61649720
MM
57[INSTALL]: INSTALL
58[Documentation/gittutorial.txt]: Documentation/gittutorial.txt
59[Documentation/giteveryday.txt]: Documentation/giteveryday.txt
61649720
MM
60[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
61[Documentation/SubmittingPatches]: Documentation/SubmittingPatches