Re: [RFC/PATCH 0/5] Make README more pleasant to read

From: Jeff King <peff@peff.net>
Date: Feb 24, 2016, 10:22 UTC
Message-ID: <20160224102247.GA21152@sigill.intra.peff.net>
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:

Show 18 quoted lines

> 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