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