Matthieu Moy [off-list ref] writes:
This allows repository browsers like GitHub to display the content of
the file nicely formatted.
Signed-off-by: Matthieu Moy <redacted>
---
To be honest, I have the most problem with this step in the whole
series.
Markdown when rendered may be easier to read, but plain text is even
easier, and it somehow feels backward to cater to those who browse
at GitHub sacrificing those who use "less" in the source tree.
quoted hunk
README => README.md | 6 +-----
t/t7001-mv.sh | 2 +-
2 files changed, 2 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 1083735..907eb3b 100644
--- a/README
+++ b/README.md
@@ -1,8 +1,4 @@
-////////////////////////////////////////////////////////////////
-
- 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 51dd2b4..4008fae 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'
Hi Junio,
On Tue, 23 Feb 2016, Junio C Hamano wrote:
Matthieu Moy [off-list ref] writes:
quoted
This allows repository browsers like GitHub to display the content of
the file nicely formatted.
Signed-off-by: Matthieu Moy <redacted>
---
To be honest, I have the most problem with this step in the whole
series.
Markdown when rendered may be easier to read, but plain text is even
easier, and it somehow feels backward to cater to those who browse
at GitHub sacrificing those who use "less" in the source tree.
That assumes that the primary audience of the README file is the
developers who already decided to clone the repository, as opposed to
people browsing the README file in the browser to determine whether they
found the correct project, or to read up on the background of the project
without downloading the entire source code.
I'd wager real money (without scientific evidence. just going on common
sense) that your 'less' people are in the vast minority.
Since I am convinced that markdown'ed READMEs enhance the user experience
dramatically, Git for Windows has one already for a long time.
Hence *my* main objection: this patch series would conflict with patches
we carry in Git for Windows.
;-)
Ciao,
Dscho
P.S.: If it was not clear, my objection was meant as a joke. I am very
much in favor of enhancing the user experience via Matthieu's patches.
On Wed, Feb 24, 2016 at 08:08:52AM +0100, Johannes Schindelin wrote:
quoted
Markdown when rendered may be easier to read, but plain text is even
easier, and it somehow feels backward to cater to those who browse
at GitHub sacrificing those who use "less" in the source tree.
That assumes that the primary audience of the README file is the
developers who already decided to clone the repository, as opposed to
people browsing the README file in the browser to determine whether they
found the correct project, or to read up on the background of the project
without downloading the entire source code.
I'd wager real money (without scientific evidence. just going on common
sense) that your 'less' people are in the vast minority.
Since I am convinced that markdown'ed READMEs enhance the user experience
dramatically, Git for Windows has one already for a long time.
Yeah, I agree. I cannot imagine why I would read Git's README at this
point in time. And I find I primarily consume READMEs on the web these
days, as they are the first step in me figuring out whether a project is
worth looking into.
Whereas I _do_ care what things like Documentation/technical look like,
or CodingGuidelines, because I actually refer to them locally.
IMHO the title formatting is somewhat moot, though, as we can have our
cake and eat it, too, with the "====" underlines. I don't think they are
any worse than the lines of slashes in the original. :)
I'd worry more about the [] links from patch 2, but even those are fine
by me.
-Peff