From 4ad21f5d5979f7a192c0774881bef340d3cc86a8 Mon Sep 17 00:00:00 2001 From: Matthieu Moy Date: Thu, 25 Feb 2016 09:37:26 +0100 Subject: [PATCH 1/5] README: use markdown syntax This allows repository browsers like GitHub to display the content of the file nicely formatted. Signed-off-by: Matthieu Moy Signed-off-by: Junio C Hamano --- README => README.md | 7 ++----- t/t7001-mv.sh | 2 +- 2 files changed, 3 insertions(+), 6 deletions(-) rename README => README.md (93%) diff --git a/README b/README.md similarity index 93% rename from README rename to README.md index 1083735d1c..600779c33b 100644 --- a/README +++ b/README.md @@ -1,8 +1,5 @@ -//////////////////////////////////////////////////////////////// - - Git - the stupid content tracker - -//////////////////////////////////////////////////////////////// +Git - the stupid content tracker +================================ "git" can mean anything, depending on your mood. diff --git a/t/t7001-mv.sh b/t/t7001-mv.sh index 51dd2b4e0e..4008faead8 100755 --- a/t/t7001-mv.sh +++ b/t/t7001-mv.sh @@ -102,7 +102,7 @@ test_expect_success \ test_expect_success \ 'adding another file' \ - 'cp "$TEST_DIRECTORY"/../README path0/README && + 'cp "$TEST_DIRECTORY"/../README.md path0/README && git add path0/README && git commit -m add2 -a' From 6164972018ba3adbae2db1e7b286e2b811b3e7c2 Mon Sep 17 00:00:00 2001 From: Matthieu Moy Date: Thu, 25 Feb 2016 09:37:27 +0100 Subject: [PATCH 2/5] README.md: add hyperlinks on filenames Signed-off-by: Matthieu Moy Signed-off-by: Junio C Hamano --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 600779c33b..e54f9e7449 100644 --- a/README.md +++ b/README.md @@ -21,17 +21,17 @@ License version 2 (some parts of it are under different licenses, compatible with the GPLv2). It was originally written by Linus Torvalds with help of a group of hackers around the net. -Please read the file INSTALL for installation instructions. +Please read the file [INSTALL][] for installation instructions. -See Documentation/gittutorial.txt to get started, then see -Documentation/giteveryday.txt for a useful minimum set of commands, and -Documentation/git-commandname.txt for documentation of each command. +See [Documentation/gittutorial.txt][] to get started, then see +[Documentation/giteveryday.txt][] for a useful minimum set of commands, and +[Documentation/git-commandname.txt][] for documentation of each command. If git has been correctly installed, then the tutorial can also be read with "man gittutorial" or "git help tutorial", and the documentation of each command with "man git-commandname" or "git help commandname". -CVS users may also want to read Documentation/gitcvs-migration.txt +CVS users may also want to read [Documentation/gitcvs-migration.txt][] ("man gitcvs-migration" or "git help cvs-migration" if git is installed). @@ -41,7 +41,7 @@ including full documentation and Git related tools. The user discussion and development of Git take place on the Git mailing list -- everyone is welcome to post bug reports, feature requests, comments and patches to git@vger.kernel.org (read -Documentation/SubmittingPatches for instructions on patch submission). +[Documentation/SubmittingPatches][] for instructions on patch submission). To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org. The mailing list archives are available at http://news.gmane.org/gmane.comp.version-control.git/, @@ -51,3 +51,10 @@ The maintainer frequently sends the "What's cooking" reports that list the current status of various development topics to the mailing list. The discussion following them give a good reference for project status, development direction and remaining tasks. + +[INSTALL]: INSTALL +[Documentation/gittutorial.txt]: Documentation/gittutorial.txt +[Documentation/giteveryday.txt]: Documentation/giteveryday.txt +[Documentation/git-commandname.txt]: Documentation/git-commandname.txt +[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt +[Documentation/SubmittingPatches]: Documentation/SubmittingPatches From d9b297db70b29189398772c2997754420d323838 Mon Sep 17 00:00:00 2001 From: Matthieu Moy Date: Thu, 25 Feb 2016 09:37:28 +0100 Subject: [PATCH 3/5] README.md: move the link to git-scm.com up The documentation available on git-scm.com is nicely formatted. It's better to point users to it than to the source code of the documentation. Signed-off-by: Matthieu Moy Signed-off-by: Junio C Hamano --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e54f9e7449..5500f8a718 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,9 @@ Torvalds with help of a group of hackers around the net. Please read the file [INSTALL][] for installation instructions. +Many Git online resources are accessible from http://git-scm.com/ +including full documentation and Git related tools. + See [Documentation/gittutorial.txt][] to get started, then see [Documentation/giteveryday.txt][] for a useful minimum set of commands, and [Documentation/git-commandname.txt][] for documentation of each command. @@ -35,9 +38,6 @@ CVS users may also want to read [Documentation/gitcvs-migration.txt][] ("man gitcvs-migration" or "git help cvs-migration" if git is installed). -Many Git online resources are accessible from http://git-scm.com/ -including full documentation and Git related tools. - The user discussion and development of Git take place on the Git mailing list -- everyone is welcome to post bug reports, feature requests, comments and patches to git@vger.kernel.org (read From 28513c4f56a2164fd6d3a16ceddbab3a5bf3f191 Mon Sep 17 00:00:00 2001 From: Matthieu Moy Date: Thu, 25 Feb 2016 09:37:29 +0100 Subject: [PATCH 4/5] README.md: don't call git stupid in the title "the stupid content tracker" was true in the early days of Git, but hardly applicable these days. "fast, scalable, distributed" describes Git more accuralety. Also, "stupid" can be seen as offensive by some people. Let's not use it in the very first words of the README. The new formulation is taken from the description of the Debian package. Signed-off-by: Matthieu Moy Signed-off-by: Junio C Hamano --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5500f8a718..e3ddc3e049 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -Git - the stupid content tracker -================================ +Git - fast, scalable, distributed revision control system +========================================================= "git" can mean anything, depending on your mood. From a217f07388b847192565c71e5ef6a9cc81633594 Mon Sep 17 00:00:00 2001 From: Matthieu Moy Date: Thu, 25 Feb 2016 09:37:30 +0100 Subject: [PATCH 5/5] README.md: move down historical explanation about the name The explanations about why the name was chosen are secondary compared to the description and link to the documentation. Some consider these explanations as good computer scientists joke, but other see it as needlessly offensive vocabulary. This patch preserves the historical joke, but gives it less importance by moving it to the end of the README, and makes it clear that it is a historical explanation, that does not necessarily reflect the state of mind of current developers. Signed-off-by: Matthieu Moy Signed-off-by: Junio C Hamano --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e3ddc3e049..d1ffbb6170 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,6 @@ Git - fast, scalable, distributed revision control system ========================================================= -"git" can mean anything, depending on your mood. - - - random three-letter combination that is pronounceable, and not - actually used by any common UNIX command. The fact that it is a - mispronunciation of "get" may or may not be relevant. - - stupid. contemptible and despicable. simple. Take your pick from the - dictionary of slang. - - "global information tracker": you're in a good mood, and it actually - works for you. Angels sing, and a light suddenly fills the room. - - "goddamn idiotic truckload of sh*t": when it breaks - Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high-level operations and full access to internals. @@ -52,6 +41,19 @@ list the current status of various development topics to the mailing list. The discussion following them give a good reference for project status, development direction and remaining tasks. +The name "git" was given by Linus Torvalds when he wrote the very +first version. He described the tool as "the stupid content tracker" +and the name as (depending on your mood): + + - random three-letter combination that is pronounceable, and not + actually used by any common UNIX command. The fact that it is a + mispronunciation of "get" may or may not be relevant. + - stupid. contemptible and despicable. simple. Take your pick from the + dictionary of slang. + - "global information tracker": you're in a good mood, and it actually + works for you. Angels sing, and a light suddenly fills the room. + - "goddamn idiotic truckload of sh*t": when it breaks + [INSTALL]: INSTALL [Documentation/gittutorial.txt]: Documentation/gittutorial.txt [Documentation/giteveryday.txt]: Documentation/giteveryday.txt