Inform new users what GENERIC and NOTES are. These are useful for people
perusing the tree without a great deal of specific fbsd knowledge.
See discussion of r334073 for further motivation.
Requested by: jhb
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.
Two orthogonal goals:
- try to make README look a little nicer on phabricator by using
Remarkup syntax for commands (using `` instead of using a closing ')
- try to make README look a little nicer on github.
- Don't encourage `make world` when the handbook specifies otherwise
- Change language around documentation to be a bit clearer
MFC After: 2 weeks
undocumented HISTORICAL_MAKE_WORLD variable and set it. Note it
here so the blow up will not really be a surprise to people who
read.
Link the buildingworld chapter of our handbook in the README
while I'm here.
`buildworld' is no longer a strict prerequisite for `buildkernel'
as of Makefile.inc1,v 1.184.
Fix kernel configuration files path to look MI.
Mention src/kerberos5.
- Make world doesn't build the modules any more.
- Mention the buildkernel/installkernel targets as common used targets.
- LINT has gone, NOTES is new but cannot be built. It is a pure reference
file. However, I still mentioned LINT but pointed out the difference
between the ancient LINT and the new NOTES. This should avoid confusion.
- crypto/ subdir isn't export controlled any more.
This will make a number of things easier in the future, as well as (finally!)
avoiding the Id-smashing problem which has plagued developers for so long.
Boy, I'm glad we're not using sup anymore. This update would have been
insane otherwise.
