From: Jeff King <peff@peff.net>
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: Junio C Hamano <gitster@pobox.com>,
Matthieu Moy <Matthieu.Moy@imag.fr>,
git@vger.kernel.org, emma.westby@gmail.com
Subject: Re: [PATCH 1/5] README: use markdown syntax
Date: Wed, 24 Feb 2016 05:18:57 -0500 [thread overview]
Message-ID: <20160224101857.GB20807@sigill.intra.peff.net> (raw)
In-Reply-To: <alpine.DEB.2.20.1602240801550.3152@virtualbox>
On Wed, Feb 24, 2016 at 08:08:52AM +0100, Johannes Schindelin wrote:
> > 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
next prev parent reply other threads:[~2016-02-24 10:19 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-02-23 17:40 [RFC/PATCH 0/5] Make README more pleasant to read Matthieu Moy
2016-02-23 17:40 ` [PATCH 1/5] README: use markdown syntax Matthieu Moy
2016-02-23 19:07 ` Junio C Hamano
2016-02-23 19:50 ` Matthieu Moy
2016-02-24 7:08 ` Johannes Schindelin
2016-02-24 10:18 ` Jeff King [this message]
2016-02-23 17:40 ` [PATCH 2/5] README.md: add hyperlinks on filenames Matthieu Moy
2016-02-23 19:10 ` Junio C Hamano
2016-02-23 19:52 ` Matthieu Moy
2016-02-23 17:40 ` [PATCH 3/5] README.md: move the link to git-scm.com up Matthieu Moy
2016-02-23 17:40 ` [PATCH 4/5] README.md: don't call git stupid in the title Matthieu Moy
2016-02-23 19:13 ` Junio C Hamano
2016-02-23 20:51 ` Matthieu Moy
2016-02-23 21:37 ` Junio C Hamano
2016-02-23 17:40 ` [PATCH 5/5] README.md: move down historical explanation about the name Matthieu Moy
2016-02-24 10:22 ` [RFC/PATCH 0/5] Make README more pleasant to read Jeff King
2016-02-24 13:37 ` Matthieu Moy
2016-02-25 6:14 ` Jeff King
2016-02-25 6:22 ` Junio C Hamano
2016-02-25 8:37 ` [PATCH v2 " Matthieu Moy
2016-02-25 8:37 ` [PATCH v2 1/5] README: use markdown syntax Matthieu Moy
2016-02-25 8:37 ` [PATCH v2 2/5] README.md: add hyperlinks on filenames Matthieu Moy
2016-02-25 8:37 ` [PATCH v2 3/5] README.md: move the link to git-scm.com up Matthieu Moy
2016-02-25 8:37 ` [PATCH v2 4/5] README.md: don't call git stupid in the title Matthieu Moy
2016-02-25 8:37 ` [PATCH v2 5/5] README.md: move down historical explanation about the name Matthieu Moy
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20160224101857.GB20807@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=Johannes.Schindelin@gmx.de \
--cc=Matthieu.Moy@imag.fr \
--cc=emma.westby@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).