commit.txt: clarify how --author argument is used
[git/mjg.git] / README
blob67cfeb2016b24df1cb406c18145efd399f6a1792
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 License.
23 It was originally written by Linus Torvalds with help of a group of
24 hackers around the net. It is currently maintained by Junio C Hamano.
26 Please read the file INSTALL for installation instructions.
28 See Documentation/gittutorial.txt to get started, then see
29 Documentation/everyday.txt for a useful minimum set of commands, and
30 Documentation/git-commandname.txt for documentation of each command.
31 If git has been correctly installed, then the tutorial can also be
32 read with "man gittutorial" or "git help tutorial", and the
33 documentation of each command with "man git-commandname" or "git help
34 commandname".
36 CVS users may also want to read Documentation/gitcvs-migration.txt
37 ("man gitcvs-migration" or "git help cvs-migration" if git is
38 installed).
40 Many Git online resources are accessible from http://git-scm.com/
41 including full documentation and Git related tools.
43 The user discussion and development of Git take place on the Git
44 mailing list -- everyone is welcome to post bug reports, feature
45 requests, comments and patches to git@vger.kernel.org. To subscribe
46 to the list, send an email with just "subscribe git" in the body to
47 majordomo@vger.kernel.org. The mailing list archives are available at
48 http://marc.theaimsgroup.com/?l=git and other archival sites.
50 The messages titled "A note from the maintainer", "What's in
51 git.git (stable)" and "What's cooking in git.git (topics)" and
52 the discussion following them on the mailing list give a good
53 reference for project status, development direction and
54 remaining tasks.