Re: Documentation of /usr/src directory layout
- Reply: Mitchell Horne : "Re: Documentation of /usr/src directory layout"
- In reply to: Mitchell Horne : "Documentation of /usr/src directory layout"
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Wed, 26 Oct 2022 18:06:27 UTC
On Wed, 26 Oct 2022 at 12:07, Mitchell Horne <email@example.com> wrote: > > I propose that we reduce the maintenance overhead by keeping one of > these lists as the source of truth. README.md is the more natural option > here: being located at the root of the src tree it is more discoverable > (especially for those new to the src tree), and the raw markdown text is > much more human-readable than mdoc. Of course, the added benefit is that > README.md is presented front-and-center when browsing the git repository > on GitHub, GitLab, etc. See it on my fork . Thanks Mitchell, overall I think this is a great idea. One question, is README.md the right place for this or should we add a CONTRIBUTING.md or similar?