Document merge.branchdesc configuration variable
[git/git.git] / README
CommitLineData
8ac866a8 1////////////////////////////////////////////////////////////////
6ad6d3d3 2
e83c5163
LT
3 GIT - the stupid content tracker
4
8ac866a8 5////////////////////////////////////////////////////////////////
556b6600 6
e83c5163
LT
7"git" can mean anything, depending on your mood.
8
9 - random three-letter combination that is pronounceable, and not
10 actually used by any common UNIX command. The fact that it is a
90c4851b 11 mispronunciation of "get" may or may not be relevant.
e83c5163
LT
12 - stupid. contemptible and despicable. simple. Take your pick from the
13 dictionary of slang.
14 - "global information tracker": you're in a good mood, and it actually
556b6600 15 works for you. Angels sing, and a light suddenly fills the room.
e83c5163
LT
16 - "goddamn idiotic truckload of sh*t": when it breaks
17
556b6600
NP
18Git is a fast, scalable, distributed revision control system with an
19unusually rich command set that provides both high-level operations
20and full access to internals.
21
22Git is an Open Source project covered by the GNU General Public License.
23It was originally written by Linus Torvalds with help of a group of
24hackers around the net. It is currently maintained by Junio C Hamano.
25
26Please read the file INSTALL for installation instructions.
aa98eb3d 27
8a124b82 28See Documentation/gittutorial.txt to get started, then see
aa98eb3d
CC
29Documentation/everyday.txt for a useful minimum set of commands, and
30Documentation/git-commandname.txt for documentation of each command.
31If git has been correctly installed, then the tutorial can also be
32read with "man gittutorial" or "git help tutorial", and the
33documentation of each command with "man git-commandname" or "git help
34commandname".
35
36CVS users may also want to read Documentation/gitcvs-migration.txt
37("man gitcvs-migration" or "git help cvs-migration" if git is
38installed).
556b6600 39
f73b3af3 40Many Git online resources are accessible from http://git-scm.com/
556b6600
NP
41including full documentation and Git related tools.
42
43The user discussion and development of Git take place on the Git
44mailing list -- everyone is welcome to post bug reports, feature
45requests, comments and patches to git@vger.kernel.org. To subscribe
46to the list, send an email with just "subscribe git" in the body to
47majordomo@vger.kernel.org. The mailing list archives are available at
48http://marc.theaimsgroup.com/?l=git and other archival sites.
620d3f42
JH
49
50The messages titled "A note from the maintainer", "What's in
51git.git (stable)" and "What's cooking in git.git (topics)" and
52the discussion following them on the mailing list give a good
53reference for project status, development direction and
54remaining tasks.