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

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

From
Junio C Hamano <gitster@pobox.com>
Date
Feb 25, 2016, 06:22 UTC
Message-ID
<xmqqr3g1pavf.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<20160225061456.GA3921@sigill.intra.peff.net>
Jeff King <peff@peff.net> writes:
Show 9 quoted lines
>> > I do not overly care, but I wonder if it would be nice to keep README as
>> > a symlink.
>> 
>> I can add it if people want to see it, but we already have so many files
>> at the root, I'd rather avoid adding duplicates through symlinks.
>
> That's reasonable. I thought it might appease the "I use `less README`
> to view the README" crowd, but it is probably not that hard to find the
> `.md` variant.

Well, "less README" folks would not be happy with a mere symbolic link anyway--things like [INSTALL][] are pure eyesore and regression relative to the straight text version.

I do not overly care, either. I do not think people would complain too much about the eyesore as long as the file is named README.md, so in that sense, we'd be better off not having such a symbolic link.

Previous: Jeff KingNext: Matthieu Moy
Message 19 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.