121173SjkhThis is the top level of the FreeBSD source directory.  This file
250479Speterwas last revised on:
350479Speter$FreeBSD: stable/11/README 329145 2018-02-12 01:08:44Z kevans $
421173Sjkh
521173SjkhFor copyright information, please see the file COPYRIGHT in this
621173Sjkhdirectory (additional copyright information also exists for some
721173Sjkhsources in this tree - please see the specific source directories for
821173Sjkhmore information).
921173Sjkh
1021173SjkhThe Makefile in this directory supports a number of targets for
11281727Seadlerbuilding components (or all) of the FreeBSD source tree.  See build(7)
12281727Seadlerand http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
13159363Strhodesfor more information, including setting make(1) variables.
14159363Strhodes
15281727SeadlerThe `buildkernel` and `installkernel` targets build and install
1664057Salexthe kernel and the modules (see below).  Please see the top of
1764057Salexthe Makefile in this directory for more information on the
1864057Salexstandard build targets and compile-time flags.
1921173Sjkh
20281727SeadlerBuilding a kernel is a somewhat more involved process.  See build(7), config(8),
21281727Seadlerand http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
22281727Seadlerfor more information.
23281727Seadler
2464057SalexNote: If you want to build and install the kernel with the
25281727Seadler`buildkernel` and `installkernel` targets, you might need to build
2664057Salexworld before.  More information is available in the handbook.
2721173Sjkh
28281727SeadlerThe kernel configuration files reside in the sys/<arch>/conf
29281727Seadlersub-directory.  GENERIC is the default configuration used in release builds.
30281727SeadlerNOTES contains entries and documentation for all possible
31281478Seadlerdevices, not just those commonly used.
3221173Sjkh
3321173Sjkh
3421173SjkhSource Roadmap:
3521173Sjkh---------------
36281727Seadler
3793217Srubin		System/user commands.
3821173Sjkh
39215293Sjoelcddl		Various commands and libraries under the Common Development
40215293Sjoel		and Distribution License.
41215293Sjoel
4221173Sjkhcontrib		Packages contributed by 3rd parties.
4321173Sjkh
4464047Salexcrypto		Cryptography stuff (see crypto/README).
4521173Sjkh
4693217Sruetc		Template files for /etc.
4721173Sjkh
4821173Sjkhgnu		Various commands and libraries under the GNU Public License.
4921173Sjkh		Please see gnu/COPYING* for more information.
5021173Sjkh
5121173Sjkhinclude		System include files.
5221173Sjkh
5393217Srukerberos5	Kerberos5 (Heimdal) package.
5437283Sjkh
5521173Sjkhlib		System libraries.
5621173Sjkh
5721173Sjkhlibexec		System daemons.
5821173Sjkh
5921173Sjkhrelease		Release building Makefile & associated tools.
6021173Sjkh
61156171Scerirescue		Build system for statically linked /rescue utilities.
62156171Sceri
6321173Sjkhsbin		System commands.
6421173Sjkh
6565298Smarkmsecure		Cryptographic libraries and commands.
6621173Sjkh
6721173Sjkhshare		Shared resources.
6821173Sjkh
69329145Skevansstand		Boot loader sources.
70329145Skevans
7121173Sjkhsys		Kernel sources.
7221173Sjkh
73281478Seadlertests		Regression tests which can be run by Kyua.  See tests/README
74281478Seadler		for additional information.
75281478Seadler
7621173Sjkhtools		Utilities for regression testing and miscellaneous tasks.
7721173Sjkh
7821173Sjkhusr.bin		User commands.
7921173Sjkh
8021173Sjkhusr.sbin	System administration commands.
8121173Sjkh
8221173Sjkh
8321173SjkhFor information on synchronizing your source tree with one or more of
8421173Sjkhthe FreeBSD Project's development branches, please see:
8521173Sjkh
86318447Sgjb  https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/updating-src.html
87