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

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

From
Junio C Hamano <gitster@pobox.com>
Date
Feb 23, 2016, 19:07 UTC
Message-ID
<xmqqoab71c09.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<1456249229-30454-2-git-send-email-Matthieu.Moy@imag.fr>
Matthieu Moy <Matthieu.Moy@imag.fr> writes:
Show 5 quoted lines
> 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.

Show 34 quoted lines
>  README => README.md | 6 +-----
>  t/t7001-mv.sh       | 2 +-
>  2 files changed, 2 insertions(+), 6 deletions(-)
>  rename README => README.md (93%)
>
> diff --git a/README b/README.md
> similarity index 93%
> rename from README
> rename to README.md
> index 1083735..907eb3b 100644
> --- a/README
> +++ b/README.md
> @@ -1,8 +1,4 @@
> -////////////////////////////////////////////////////////////////
> -
> -	Git - the stupid content tracker
> -
> -////////////////////////////////////////////////////////////////
> +# Git - the stupid content tracker
>  
>  "git" can mean anything, depending on your mood.
>  
> diff --git a/t/t7001-mv.sh b/t/t7001-mv.sh
> index 51dd2b4..4008fae 100755
> --- a/t/t7001-mv.sh
> +++ b/t/t7001-mv.sh
> @@ -102,7 +102,7 @@ test_expect_success \
>  
>  test_expect_success \
>      'adding another file' \
> -    'cp "$TEST_DIRECTORY"/../README path0/README &&
> +    'cp "$TEST_DIRECTORY"/../README.md path0/README &&
>       git add path0/README &&
>       git commit -m add2 -a'
Previous: Matthieu MoyNext: Matthieu Moy
Message 3 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.