blob: 7ce4f05bae8120d9fa258e854a8669f6ea9cb7b1 [file] [log] [blame] [view]
Ævar Arnfjörð Bjarmasondf7375d2021-11-23 17:29:09 +01001[![Build status](https://github.com/git/git/workflows/CI/badge.svg)](https://github.com/git/git/actions?query=branch%3Amaster+event%3Apush)
Johannes Schindelin5f786462019-01-29 06:19:32 -08002
Matthieu Moy28513c42016-02-25 09:37:29 +01003Git - fast, scalable, distributed revision control system
4=========================================================
Nicolas Pitre556b6602007-01-17 13:04:39 -05005
Nicolas Pitre556b6602007-01-17 13:04:39 -05006Git is a fast, scalable, distributed revision control system with an
7unusually rich command set that provides both high-level operations
8and full access to internals.
Linus Torvaldse83c5162005-04-07 15:13:13 -07009
Stefano Lattarini779d7e92012-12-14 16:37:47 +010010Git is an Open Source project covered by the GNU General Public
11License version 2 (some parts of it are under different licenses,
Junio C Hamano71ce4152012-12-15 22:24:10 -080012compatible with the GPLv2). It was originally written by Linus
13Torvalds with help of a group of hackers around the net.
Linus Torvalds6ad6d3d2005-04-17 21:52:23 -070014
Matthieu Moy61649722016-02-25 09:37:27 +010015Please read the file [INSTALL][] for installation instructions.
Christian Couderaa98eb32009-02-24 21:16:37 +010016
Eric Wongbcd886d2017-03-01 22:22:04 +000017Many Git online resources are accessible from <https://git-scm.com/>
Matthieu Moyd9b297d2016-02-25 09:37:28 +010018including full documentation and Git related tools.
19
Matthieu Moy61649722016-02-25 09:37:27 +010020See [Documentation/gittutorial.txt][] to get started, then see
21[Documentation/giteveryday.txt][] for a useful minimum set of commands, and
Doug Ilijev7926cee2019-07-18 12:08:45 -070022`Documentation/git-<commandname>.txt` for documentation of each command.
Christian Couderaa98eb32009-02-24 21:16:37 +010023If git has been correctly installed, then the tutorial can also be
Benjamin Dopplingera299e3a2016-05-30 03:08:16 +000024read with `man gittutorial` or `git help tutorial`, and the
25documentation of each command with `man git-<commandname>` or `git help
26<commandname>`.
Christian Couderaa98eb32009-02-24 21:16:37 +010027
Matthieu Moy61649722016-02-25 09:37:27 +010028CVS users may also want to read [Documentation/gitcvs-migration.txt][]
Benjamin Dopplingera299e3a2016-05-30 03:08:16 +000029(`man gitcvs-migration` or `git help cvs-migration` if git is
Christian Couderaa98eb32009-02-24 21:16:37 +010030installed).
Linus Torvaldse83c5162005-04-07 15:13:13 -070031
Nicolas Pitre556b6602007-01-17 13:04:39 -050032The user discussion and development of Git take place on the Git
33mailing list -- everyone is welcome to post bug reports, feature
Matthieu Moy07f050c2012-02-23 13:52:06 +010034requests, comments and patches to git@vger.kernel.org (read
Philip Oakley4ed7dfa2022-01-17 18:18:11 +000035[Documentation/SubmittingPatches][] for instructions on patch submission
36and [Documentation/CodingGuidelines][]).
37
38Those wishing to help with error message, usage and informational message
39string translations (localization l10) should see [po/README.md][]
40(a `po` file is a Portable Object file that holds the translations).
41
Matthieu Moy07f050c2012-02-23 13:52:06 +010042To subscribe to the list, send an email with just "subscribe git" in
Philip Oakley4ed7dfa2022-01-17 18:18:11 +000043the body to majordomo@vger.kernel.org (not the Git list). The mailing
44list archives are available at <https://lore.kernel.org/git/>,
Eric Wongbcd886d2017-03-01 22:22:04 +000045<http://marc.info/?l=git> and other archival sites.
Junio C Hamano620d3f42007-03-25 17:42:32 -070046
Thomas Gummerer2a005022018-05-30 21:52:55 +010047Issues which are security relevant should be disclosed privately to
48the Git Security mailing list <git-security@googlegroups.com>.
49
Junio C Hamano33b29fd2013-01-29 11:10:58 -080050The 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.
Matthieu Moy61649722016-02-25 09:37:27 +010054
Matthieu Moya217f072016-02-25 09:37:30 +010055The name "git" was given by Linus Torvalds when he wrote the very
56first version. He described the tool as "the stupid content tracker"
57and the name as (depending on your mood):
58
59 - random three-letter combination that is pronounceable, and not
60 actually used by any common UNIX command. The fact that it is a
61 mispronunciation of "get" may or may not be relevant.
62 - stupid. contemptible and despicable. simple. Take your pick from the
63 dictionary of slang.
64 - "global information tracker": you're in a good mood, and it actually
65 works for you. Angels sing, and a light suddenly fills the room.
66 - "goddamn idiotic truckload of sh*t": when it breaks
67
Matthieu Moy61649722016-02-25 09:37:27 +010068[INSTALL]: INSTALL
69[Documentation/gittutorial.txt]: Documentation/gittutorial.txt
70[Documentation/giteveryday.txt]: Documentation/giteveryday.txt
Matthieu Moy61649722016-02-25 09:37:27 +010071[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
72[Documentation/SubmittingPatches]: Documentation/SubmittingPatches
Philip Oakley4ed7dfa2022-01-17 18:18:11 +000073[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
74[po/README.md]: po/README.md