git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, emma.westby@gmail.com
Subject: Re: [PATCH 2/5] README.md: add hyperlinks on filenames
Date: Tue, 23 Feb 2016 20:52:48 +0100	[thread overview]
Message-ID: <vpqwppvfblb.fsf@anie.imag.fr> (raw)
In-Reply-To: <xmqqio1f1bw7.fsf@gitster.mtv.corp.google.com> (Junio C. Hamano's message of "Tue, 23 Feb 2016 11:10:00 -0800")

Junio C Hamano <gitster@pobox.com> writes:

> Matthieu Moy <Matthieu.Moy@imag.fr> writes:
>
>> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
>> ---
>>  README.md | 19 +++++++++++++------
>>  1 file changed, 13 insertions(+), 6 deletions(-)
>
> Makes sense, provided if we want to do Markdown.

I'd say it the other way around: declaring README as markdown costs
almost nothing and doesn't harm source code readability. This patch
slightly decreases the source's readability so we may want to drop it.

> If I were pushing this topic (i.e. cater to those who browse at
> GitHub, not with "less" in the source tree), I'd have further made
> these links to the preformatted documentation at git-scm.com; I
> expected the later steps in this series to do that, but it seems you
> stopped short of it for some reason.

I tried to keep the spirit of the README as "this is the entry point to
the source code" rather than "this is the new homepage of Git" (as some
project do on GitHub, but we have such a nice git-scm.com ...).

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/

  reply	other threads:[~2016-02-23 19:52 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
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 [this message]
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=vpqwppvfblb.fsf@anie.imag.fr \
    --to=matthieu.moy@grenoble-inp.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).