Merge branch 'yd/doc-merge-annotated-tag' into maint
[git/jnareb-git.git] / README
blob15a8e235012a247e6f22abd2c298a2e43c940c61
1 ////////////////////////////////////////////////////////////////
3         Git - the stupid content tracker
5 ////////////////////////////////////////////////////////////////
7 "git" can mean anything, depending on your mood.
9  - random three-letter combination that is pronounceable, and not
10    actually used by any common UNIX command.  The fact that it is a
11    mispronunciation of "get" may or may not be relevant.
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
15    works for you. Angels sing, and a light suddenly fills the room.
16  - "goddamn idiotic truckload of sh*t": when it breaks
18 Git is a fast, scalable, distributed revision control system with an
19 unusually rich command set that provides both high-level operations
20 and full access to internals.
22 Git is an Open Source project covered by the GNU General Public
23 License version 2 (some parts of it are under different licenses,
24 compatible with the GPLv2). It was originally written by Linus
25 Torvalds with help of a group of hackers around the net.
27 Please read the file INSTALL for installation instructions.
29 See Documentation/gittutorial.txt to get started, then see
30 Documentation/everyday.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 Many Git online resources are accessible from http://git-scm.com/
42 including full documentation and Git related tools.
44 The user discussion and development of Git take place on the Git
45 mailing list -- everyone is welcome to post bug reports, feature
46 requests, comments and patches to git@vger.kernel.org (read
47 Documentation/SubmittingPatches for instructions on patch submission).
48 To subscribe to the list, send an email with just "subscribe git" in
49 the body to majordomo@vger.kernel.org. The mailing list archives are
50 available at http://news.gmane.org/gmane.comp.version-control.git/,
51 http://marc.info/?l=git and other archival sites.
53 The maintainer frequently sends the "What's cooking" reports that
54 list the current status of various development topics to the mailing
55 list.  The discussion following them give a good reference for
56 project status, development direction and remaining tasks.