path: root/README.md
diff options
authorEitan Adler <eadler@FreeBSD.org>2018-05-23 04:09:01 +0000
committerEitan Adler <eadler@FreeBSD.org>2018-05-23 04:09:01 +0000
commit7c0631790c64b818abe97b5f0f63c8a8fa0c8b94 (patch)
treea2cc0e1cc4e73e660fd443073b2cd33ff76c40c2 /README.md
parent0db9a543bcb52bf60d934fceba1c2d55a92a457d (diff)
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.
Notes: svn path=/head/; revision=334073
Diffstat (limited to 'README.md')
1 files changed, 15 insertions, 23 deletions
diff --git a/README.md b/README.md
index 1064be3afcb5..a5ae8293ce92 100644
--- a/README.md
+++ b/README.md
@@ -4,35 +4,25 @@ This is the top level of the FreeBSD source directory. This file
was last revised on:
+FreeBSD is an operating system used to power modern servers,
+desktops, and embedded platforms. A large community has
+continually developed it for more than thirty years. Its
+advanced networking, security, and storage features have
+made FreeBSD the platform of choice for many of the
+busiest web sites and most pervasive embedded networking
+and storage devices.
For copyright information, please see the file COPYRIGHT in this
-directory (additional copyright information also exists for some
+directory. Additional copyright information also exists for some
sources in this tree - please see the specific source directories for
-more information).
+more information.
The Makefile in this directory supports a number of targets for
-building components (or all) of the FreeBSD source tree. See build(7)
-and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
+building components (or all) of the FreeBSD source tree. See build(7), config(8),
+https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html, and
for more information, including setting make(1) variables.
-The `buildkernel` and `installkernel` targets build and install
-the kernel and the modules (see below). Please see the top of
-the Makefile in this directory for more information on the
-standard build targets and compile-time flags.
-Building a kernel is a somewhat more involved process. See build(7), config(8),
-and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
-for more information.
-Note: If you want to build and install the kernel with the
-`buildkernel` and `installkernel` targets, you might need to build
-world before. More information is available in the handbook.
-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.
Source Roadmap:
@@ -72,6 +62,8 @@ stand Boot loader sources.
sys Kernel sources.
+sys/<arch>/conf Kernel configuration file
tests Regression tests which can be run by Kyua. See tests/README
for additional information.