[PATCH v2 0/5] Make README more pleasant to read
- From
Matthieu Moy <matthieu.moy@imag.fr>
- Date
- Feb 25, 2016, 08:37 UTC
- Message-ID
- <1456389450-27118-1-git-send-email-Matthieu.Moy@imag.fr>
- In-Reply-To
- <1456249229-30454-1-git-send-email-Matthieu.Moy@imag.fr>
Minor tweaks after discussion on v1 (for those who missed it, this series makes README render nicely on GitHub and tries to present important information early).
The result is here:
https://github.com/moy/git/tree/git-readme#readme
Changes since v1:
* Visible on the rendered page: resurect "the stupid content tracker"
at the bottom ("He described the tool as "the stupid content
tracker" and the name as (depending on your mood)") as suggested by
Junio. I first disagreed, but that's part of the explanation why Git
is called Git, so why not.* Visible only in the source: change
# title
to
title =====
(I chose the first because it was more easy to type, but for someone not familiar with markdown, the second makes it more obvious that its' a title)
I kept the patch introducing explicit links on filenames. I do not care deeply about it.
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
README => README.md | 56 +++++++++++++++++++++++++++++------------------------ t/t7001-mv.sh | 2 +- 2 files changed, 32 insertions(+), 26 deletions(-) rename README => README.md (65%)
-- 2.7.2.334.g35ed2ae.dirty