On 23 May 2018 at 09:27, John Baldwin <j...@freebsd.org> wrote: > On Wednesday, May 23, 2018 04:09:01 AM Eitan Adler wrote: >> Author: eadler >> Date: Wed May 23 04:09:01 2018 >> New Revision: 334073 >> URL: https://svnweb.freebsd.org/changeset/base/334073 >> >> Log: >> README: Reduce the textdump; describe the project >> >> Rework the README to make it a little easier for new users. This is the >> first file many will see when persuing the FreeBSD source code so >> >> - remove some of the text describes how to build. This is better covered >> in the linked documentation. >> - add a small blurb for what FreeBSD is. Some users might find this >> document through features such as github search so they may not even >> know what the project is >> >> generally, gear this file for the new, accidental, or casual user rather >> than towards someone seeking fuller documentation. >> >> Modified: >> head/README >> head/README.md >> >> Modified: head/README >> ============================================================================== >> --- head/README Wed May 23 03:41:22 2018 (r334072) >> +++ head/README Wed May 23 04:09:01 2018 (r334073) >> @@ -2,35 +2,25 @@ This is the top level of the FreeBSD source directory. >> - >> -The kernel configuration files reside in the sys/<arch>/conf >> -sub-directory. GENERIC is the default configuration used in release builds. >> -NOTES contains entries and documentation for all possible >> -devices, not just those commonly used. > > I do think this paragraph is still useful as part of the Source Roadmap and > not really part of the build instructions.
I added a reference to sys/<arch>/conf to the bottom of the README.Adding something about NOTES might be helpful, but IMHO closer to the build. -- Eitan Adler Source, Ports, Doc committer Bugmeister, Ports Security teams _______________________________________________ svn-src-head@freebsd.org mailing list https://lists.freebsd.org/mailman/listinfo/svn-src-head To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"
