svn commit: r334073 - head

[Benjamin Kaduk]

On Tue, May 22, 2018 at 11:09 PM, Eitan Adler <eadler at freebsd.org> 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
>

Changes to "the first file many will see when perusing the FreeBSD source
code" seem like something sufficiently impactful that pre-commit review
and/or
consultation with other committers would be advised.

(That said, these changes do seem reasonable, on a quick read.)

-Ben