Skip to content

Commit b52cb95

Browse files
committed
Merge branch 'mm/readme-markdown'
README has been renamed to README.md and its contents got tweaked slightly to make it easier on the eyes. * mm/readme-markdown: README.md: move down historical explanation about the name README.md: don't call git stupid in the title README.md: move the link to git-scm.com up README.md: add hyperlinks on filenames README: use markdown syntax
2 parents 2e55d30 + a217f07 commit b52cb95

File tree

2 files changed

+32
-26
lines changed

2 files changed

+32
-26
lines changed

README renamed to README.md

Lines changed: 31 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,5 @@
1-
////////////////////////////////////////////////////////////////
2-
3-
Git - the stupid content tracker
4-
5-
////////////////////////////////////////////////////////////////
6-
7-
"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
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
1+
Git - fast, scalable, distributed revision control system
2+
=========================================================
173

184
Git is a fast, scalable, distributed revision control system with an
195
unusually rich command set that provides both high-level operations
@@ -24,27 +10,27 @@ License version 2 (some parts of it are under different licenses,
2410
compatible with the GPLv2). It was originally written by Linus
2511
Torvalds with help of a group of hackers around the net.
2612

27-
Please read the file INSTALL for installation instructions.
13+
Please read the file [INSTALL][] for installation instructions.
14+
15+
Many Git online resources are accessible from http://git-scm.com/
16+
including full documentation and Git related tools.
2817

29-
See Documentation/gittutorial.txt to get started, then see
30-
Documentation/giteveryday.txt for a useful minimum set of commands, and
31-
Documentation/git-commandname.txt for documentation of each command.
18+
See [Documentation/gittutorial.txt][] to get started, then see
19+
[Documentation/giteveryday.txt][] for a useful minimum set of commands, and
20+
[Documentation/git-commandname.txt][] for documentation of each command.
3221
If git has been correctly installed, then the tutorial can also be
3322
read with "man gittutorial" or "git help tutorial", and the
3423
documentation of each command with "man git-commandname" or "git help
3524
commandname".
3625

37-
CVS users may also want to read Documentation/gitcvs-migration.txt
26+
CVS users may also want to read [Documentation/gitcvs-migration.txt][]
3827
("man gitcvs-migration" or "git help cvs-migration" if git is
3928
installed).
4029

41-
Many Git online resources are accessible from http://git-scm.com/
42-
including full documentation and Git related tools.
43-
4430
The user discussion and development of Git take place on the Git
4531
mailing list -- everyone is welcome to post bug reports, feature
4632
requests, comments and patches to [email protected] (read
47-
Documentation/SubmittingPatches for instructions on patch submission).
33+
[Documentation/SubmittingPatches][] for instructions on patch submission).
4834
To subscribe to the list, send an email with just "subscribe git" in
4935
the body to [email protected]. The mailing list archives are
5036
available at http://news.gmane.org/gmane.comp.version-control.git/,
@@ -54,3 +40,23 @@ The maintainer frequently sends the "What's cooking" reports that
5440
list the current status of various development topics to the mailing
5541
list. The discussion following them give a good reference for
5642
project status, development direction and remaining tasks.
43+
44+
The name "git" was given by Linus Torvalds when he wrote the very
45+
first version. He described the tool as "the stupid content tracker"
46+
and the name as (depending on your mood):
47+
48+
- random three-letter combination that is pronounceable, and not
49+
actually used by any common UNIX command. The fact that it is a
50+
mispronunciation of "get" may or may not be relevant.
51+
- stupid. contemptible and despicable. simple. Take your pick from the
52+
dictionary of slang.
53+
- "global information tracker": you're in a good mood, and it actually
54+
works for you. Angels sing, and a light suddenly fills the room.
55+
- "goddamn idiotic truckload of sh*t": when it breaks
56+
57+
[INSTALL]: INSTALL
58+
[Documentation/gittutorial.txt]: Documentation/gittutorial.txt
59+
[Documentation/giteveryday.txt]: Documentation/giteveryday.txt
60+
[Documentation/git-commandname.txt]: Documentation/git-commandname.txt
61+
[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
62+
[Documentation/SubmittingPatches]: Documentation/SubmittingPatches

t/t7001-mv.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ test_expect_success \
102102

103103
test_expect_success \
104104
'adding another file' \
105-
'cp "$TEST_DIRECTORY"/../README path0/README &&
105+
'cp "$TEST_DIRECTORY"/../README.md path0/README &&
106106
git add path0/README &&
107107
git commit -m add2 -a'
108108

0 commit comments

Comments
 (0)