blob: d2690ec8dc6e5f054c33a5f3b4c26f6ad038706d [file] [log] [blame]
David Greaves8ac866a2005-05-22 18:44:16 +01001////////////////////////////////////////////////////////////////
Linus Torvalds6ad6d3d2005-04-17 21:52:23 -07002
Linus Torvaldse83c5162005-04-07 15:13:13 -07003 GIT - the stupid content tracker
4
David Greaves8ac866a2005-05-22 18:44:16 +01005////////////////////////////////////////////////////////////////
Nicolas Pitre556b6602007-01-17 13:04:39 -05006
Linus Torvaldse83c5162005-04-07 15:13:13 -07007"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
Pavel Roskin90c48512005-04-14 23:35:00 -040011 mispronunciation of "get" may or may not be relevant.
Linus Torvaldse83c5162005-04-07 15:13:13 -070012 - 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
Nicolas Pitre556b6602007-01-17 13:04:39 -050015 works for you. Angels sing, and a light suddenly fills the room.
Linus Torvaldse83c5162005-04-07 15:13:13 -070016 - "goddamn idiotic truckload of sh*t": when it breaks
17
Nicolas Pitre556b6602007-01-17 13:04:39 -050018Git 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.
Linus Torvaldse83c5162005-04-07 15:13:13 -070021
Nicolas Pitre556b6602007-01-17 13:04:39 -050022Git 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.
Linus Torvalds6ad6d3d2005-04-17 21:52:23 -070025
Nicolas Pitre556b6602007-01-17 13:04:39 -050026Please read the file INSTALL for installation instructions.
Christian Couderaa98eb32009-02-24 21:16:37 +010027
Joey Hess8a124b82009-01-06 23:23:37 -050028See Documentation/gittutorial.txt to get started, then see
Christian Couderaa98eb32009-02-24 21:16:37 +010029Documentation/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).
Linus Torvaldse83c5162005-04-07 15:13:13 -070039
Stefan Naewef73b3af2009-10-07 14:14:24 +020040Many Git online resources are accessible from http://git-scm.com/
Nicolas Pitre556b6602007-01-17 13:04:39 -050041including full documentation and Git related tools.
Linus Torvaldse83c5162005-04-07 15:13:13 -070042
Nicolas Pitre556b6602007-01-17 13:04:39 -050043The user discussion and development of Git take place on the Git
44mailing list -- everyone is welcome to post bug reports, feature
Matthieu Moy07f050c2012-02-23 13:52:06 +010045requests, comments and patches to git@vger.kernel.org (read
46Documentation/SubmittingPatches for instructions on patch submission).
47To subscribe to the list, send an email with just "subscribe git" in
48the body to majordomo@vger.kernel.org. The mailing list archives are
49available at http://marc.theaimsgroup.com/?l=git and other archival
50sites.
Junio C Hamano620d3f42007-03-25 17:42:32 -070051
52The messages titled "A note from the maintainer", "What's in
53git.git (stable)" and "What's cooking in git.git (topics)" and
54the discussion following them on the mailing list give a good
55reference for project status, development direction and
56remaining tasks.