Date: Wed, 26 Oct 2022 14:06:27 -0400 From: Ed Maste <emaste@freebsd.org> To: Mitchell Horne <mhorne@freebsd.org> Cc: freebsd-arch@freebsd.org, "freebsd-doc@FreeBSD.org" <freebsd-doc@freebsd.org> Subject: Re: Documentation of /usr/src directory layout Message-ID: <CAPyFy2BXhWoPmGxQpjbqq=F7Zh2qjreqCBVSVZyS5AQdE95qeA@mail.gmail.com> In-Reply-To: <b453ee35-e0ae-127c-cc22-1193d44c9bd4@freebsd.org> References: <b453ee35-e0ae-127c-cc22-1193d44c9bd4@freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On Wed, 26 Oct 2022 at 12:07, Mitchell Horne <mhorne@freebsd.org> 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?
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAPyFy2BXhWoPmGxQpjbqq=F7Zh2qjreqCBVSVZyS5AQdE95qeA>