From: Jeff King <peff@peff.net>
To: Matthieu Moy <Matthieu.Moy@imag.fr>
Cc: git@vger.kernel.org, emma.westby@gmail.com
Subject: Re: [RFC/PATCH 0/5] Make README more pleasant to read
Date: Wed, 24 Feb 2016 05:22:47 -0500 [thread overview]
Message-ID: <20160224102247.GA21152@sigill.intra.peff.net> (raw)
In-Reply-To: <1456249229-30454-1-git-send-email-Matthieu.Moy@imag.fr>
On Tue, Feb 23, 2016 at 06:40:24PM +0100, Matthieu Moy wrote:
> This patch series was inspired by a discussion I had with Emma Jane
> after Git Merge last year. It tries both to make the README file less
> agressive and generally more pleasant to read.
>
> To get a quick overview, compare the old one:
>
> https://github.com/git/git#readme
>
> and my proposal:
>
> https://github.com/moy/git/tree/git-readme#readme
>
> Matthieu Moy (5):
> README: use markdown syntax
> README.md: add hyperlinks on filenames
> README.md: move the link to git-scm.com up
> README.md: don't call git stupid in the title
> README.md: move down historical explanation about the name
Thanks for working on this. I think the end product is much nicer on the
web, with very little downside for local viewing.
I'm especially happy about the final patch. I don't look at Git's README
often, but I always cringe when I see that intro paragraph and think
that it's some people's first introduction to what git is.
> README => README.md | 54 ++++++++++++++++++++++++++++-------------------------
> t/t7001-mv.sh | 2 +-
I do not overly care, but I wonder if it would be nice to keep README as
a symlink. I don't think that complicates things for people checking out
on Windows (we already have RelNotes as a symlink, and IIRC they just
get a file with the link contents. Not helpful, but not harmful to them
either).
-Peff
next prev parent reply other threads:[~2016-02-24 10:22 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
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 ` Jeff King [this message]
2016-02-24 13:37 ` [RFC/PATCH 0/5] Make README more pleasant to read 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=20160224102247.GA21152@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=Matthieu.Moy@imag.fr \
--cc=emma.westby@gmail.com \
--cc=git@vger.kernel.org \
/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).