README.md

   1 [![Build status](https://github.com/git/git/workflows/CI/badge.svg)](https://github.com/git/git/actions?query=branch%3Amaster+event%3Apush)
   2
   3 Git - fast, scalable, distributed revision control system
   4 =========================================================
   5
   6 Git is a fast, scalable, distributed revision control system with an
   7 unusually rich command set that provides both high-level operations
   8 and full access to internals.
   9
  10 Git is an Open Source project covered by the GNU General Public
  11 License version 2 (some parts of it are under different licenses,
  12 compatible with the GPLv2). It was originally written by Linus
  13 Torvalds with help of a group of hackers around the net.
  14
  15 Please read the file [INSTALL][] for installation instructions.
  16
  17 Many Git online resources are accessible from <https://git-scm.com/>
  18 including full documentation and Git related tools.
  19
  20 See [Documentation/gittutorial.txt][] to get started, then see
  21 [Documentation/giteveryday.txt][] for a useful minimum set of commands, and
  22 `Documentation/git-<commandname>.txt` for documentation of each command.
  23 If git has been correctly installed, then the tutorial can also be
  24 read with `man gittutorial` or `git help tutorial`, and the
  25 documentation of each command with `man git-<commandname>` or `git help
  26 <commandname>`.
  27
  28 CVS users may also want to read [Documentation/gitcvs-migration.txt][]
  29 (`man gitcvs-migration` or `git help cvs-migration` if git is
  30 installed).
  31
  32 The user discussion and development of Git take place on the Git
  33 mailing list -- everyone is welcome to post bug reports, feature
  34 requests, comments and patches to git@vger.kernel.org (read
  35 [Documentation/SubmittingPatches][] for instructions on patch submission
  36 and [Documentation/CodingGuidelines][]).
  37
  38 Those wishing to help with error message, usage and informational message
  39 string translations (localization l10) should see [po/README.md][]
  40 (a `po` file is a Portable Object file that holds the translations).
  41
  42 To subscribe to the list, send an email with just "subscribe git" in
  43 the body to majordomo@vger.kernel.org (not the Git list). The mailing
  44 list archives are available at <https://lore.kernel.org/git/>,
  45 <https://marc.info/?l=git> and other archival sites.
  46
  47 Issues which are security relevant should be disclosed privately to
  48 the Git Security mailing list <git-security@googlegroups.com>.
  49
  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.
  54
  55 The name "git" was given by Linus Torvalds when he wrote the very
  56 first version. He described the tool as "the stupid content tracker"
  57 and 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
  68 [INSTALL]: INSTALL
  69 [Documentation/gittutorial.txt]: Documentation/gittutorial.txt
  70 [Documentation/giteveryday.txt]: Documentation/giteveryday.txt
  71 [Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
  72 [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
  73 [Documentation/CodingGuidelines]: Documentation/CodingGuidelines
  74 [po/README.md]: po/README.md