git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/5] README: use markdown syntax

From
Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Date
Feb 23, 2016, 19:50 UTC
Message-ID
<vpq60xfgq9q.fsf@anie.imag.fr>
In-Reply-To
<xmqqoab71c09.fsf@gitster.mtv.corp.google.com>
Junio C Hamano <gitster@pobox.com> writes:
Show 14 quoted lines
> Matthieu Moy <Matthieu.Moy@imag.fr> writes:
>
>> This allows repository browsers like GitHub to display the content of
>> the file nicely formatted.
>>
>> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
>> ---
>
> To be honest, I have the most problem with this step in the whole
> series.
>
> 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.

Well, actually almost all the page was already in markdown. The real change done by this patch is a rename, and change the asciiart in the title:

Show 9 quoted lines
>> --- a/README
>> +++ b/README.md
>> @@ -1,8 +1,4 @@
>> -////////////////////////////////////////////////////////////////
>> -
>> -	Git - the stupid content tracker
>> -
>> -////////////////////////////////////////////////////////////////
>> +# Git - the stupid content tracker
Markdown would also accept ascii-art underlining.

Git - the stupid content tracker ================================

we can use this if people think it's easier to read in the source.
-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/
Previous: Junio C HamanoNext: Johannes Schindelin
Message 4 of 25 in “Make README more pleasant to read”
  1. 0/5 Make README more pleasant to readMatthieu Moy, Feb 23, 2016
  2. 1/5 README: use markdown syntaxMatthieu Moy, Feb 23, 2016
  3. Junio C HamanoFeb 23, 2016
  4. Matthieu MoyFeb 23, 2016
  5. Johannes SchindelinFeb 24, 2016
  6. Jeff KingFeb 24, 2016
  7. 2/5 README.md: add hyperlinks on filenamesMatthieu Moy, Feb 23, 2016
  8. Junio C HamanoFeb 23, 2016
  9. Matthieu MoyFeb 23, 2016
  10. 3/5 README.md: move the link to git-scm.com upMatthieu Moy, Feb 23, 2016
  11. 4/5 README.md: don't call git stupid in the titleMatthieu Moy, Feb 23, 2016
  12. Junio C HamanoFeb 23, 2016
  13. Matthieu MoyFeb 23, 2016
  14. Junio C HamanoFeb 23, 2016
  15. 5/5 README.md: move down historical explanation about the nameMatthieu Moy, Feb 23, 2016
  16. Jeff KingFeb 24, 2016
  17. Matthieu MoyFeb 24, 2016
  18. Jeff KingFeb 25, 2016
  19. Junio C HamanoFeb 25, 2016
  20. 0/5 Make README more pleasant to readMatthieu Moy, Feb 25, 2016
  21. 1/5 README: use markdown syntaxMatthieu Moy, Feb 25, 2016
  22. 2/5 README.md: add hyperlinks on filenamesMatthieu Moy, Feb 25, 2016
  23. 3/5 README.md: move the link to git-scm.com upMatthieu Moy, Feb 25, 2016
  24. 4/5 README.md: don't call git stupid in the titleMatthieu Moy, Feb 25, 2016
  25. 5/5 README.md: move down historical explanation about the nameMatthieu Moy, Feb 25, 2016

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.