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