Re: README.md files per directory
Adrian Chadd <[email protected]>
| Newsgroups | gmane.os.freebsd.devel.hackers |
|---|---|
| Message-ID | <CAJ-VmokKASrD26x861hJuecy0CFmRzQfZgehX3iQ6O3R__TXfg@mail.gmail.com> |
On Thu, 16 Apr 2026 at 11:34, Farhan Khan <[email protected]> wrote: > > Any thoughts on having README.md files in each directory? It would describe what the code was for, the maintainer, things that might help a would-be developer, status, TODOs, etc. > > There's some code I recently found that I had no idea what it was until I asked AI. It might also be useful in public code displayers, such as Github, Gitea, etc. Honestly I've wondered about potentially putting README.md files in places to basically be a "Design Doc" summary of the subsystem (notably net80211, but also describing ifnet and desired locking examples, how the USB stack functions, etc.) I don't think we have any guidelines about it yet. -adrian