Re: Documentation of /usr/src directory layout

Ed Maste <[email protected]>
Newsgroups gmane.os.freebsd.devel.documentation,gmane.os.freebsd.architechture
Message-ID <CAPyFy2BXhWoPmGxQpjbqq=F7Zh2qjreqCBVSVZyS5AQdE95qeA@mail.gmail.com> 
On Wed, 26 Oct 2022 at 12:07, Mitchell Horne <[email protected]> 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 [2].

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?
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.