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

Re: [PATCH] Documentation: add a README file

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Mar 21, 2013, 22:09 UTC
Message-ID
<20130321220906.GB12223@google.com>
In-Reply-To
<1363903193.6289.57.camel@test.quest-ce.net>
Yann Droneaud wrote:
Show 9 quoted lines
> Anyway, having a README at the Documentation/ level could also help to
> explain what to be found in this directory:
> - user-manual
> - howto
> - technical
> - RelNote
> - SubmittingPatches
> - CodingGuidelines
> - etc.

A Documentation/README or Documentation/INDEX in the spirit of Linux's Documentation/00-INDEX could be interesting if it does not bitrot (unlike Linux's 00-INDEX). Presumably that means it would have to be pretty brief.

Thanks, Jonathan

Previous: Yann Droneaud
Message 8 of 8 in “Documentation: add a README file”
  1. Documentation: add a README fileYann Droneaud, Mar 21, 2013
  2. Junio C HamanoMar 21, 2013
  3. Yann DroneaudMar 21, 2013
  4. Junio C HamanoMar 21, 2013
  5. Junio C HamanoMar 21, 2013
  6. Yann DroneaudMar 21, 2013
  7. Yann DroneaudMar 21, 2013
  8. Jonathan NiederMar 21, 2013

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.