xref: /freebsd/README.md (revision 4f52dfbb8d6c4d446500c5b097e3806ec219fbd4)
1FreeBSD Source:
2---------------
3This is the top level of the FreeBSD source directory.  This file
4was last revised on:
5$FreeBSD$
6
7For copyright information, please see the file COPYRIGHT in this
8directory (additional copyright information also exists for some
9sources in this tree - please see the specific source directories for
10more information).
11
12The Makefile in this directory supports a number of targets for
13building components (or all) of the FreeBSD source tree.  See build(7)
14and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
15for more information, including setting make(1) variables.
16
17The `buildkernel` and `installkernel` targets build and install
18the kernel and the modules (see below).  Please see the top of
19the Makefile in this directory for more information on the
20standard build targets and compile-time flags.
21
22Building a kernel is a somewhat more involved process.  See build(7), config(8),
23and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
24for more information.
25
26Note: If you want to build and install the kernel with the
27`buildkernel` and `installkernel` targets, you might need to build
28world before.  More information is available in the handbook.
29
30The kernel configuration files reside in the `sys/<arch>/conf`
31sub-directory.  GENERIC is the default configuration used in release builds.
32NOTES contains entries and documentation for all possible
33devices, not just those commonly used.
34
35
36Source Roadmap:
37---------------
38```
39bin		System/user commands.
40
41cddl		Various commands and libraries under the Common Development
42		and Distribution License.
43
44contrib		Packages contributed by 3rd parties.
45
46crypto		Cryptography stuff (see crypto/README).
47
48etc		Template files for /etc.
49
50gnu		Various commands and libraries under the GNU Public License.
51		Please see gnu/COPYING* for more information.
52
53include		System include files.
54
55kerberos5	Kerberos5 (Heimdal) package.
56
57lib		System libraries.
58
59libexec		System daemons.
60
61release		Release building Makefile & associated tools.
62
63rescue		Build system for statically linked /rescue utilities.
64
65sbin		System commands.
66
67secure		Cryptographic libraries and commands.
68
69share		Shared resources.
70
71stand		Boot loader sources.
72
73sys		Kernel sources.
74
75tests		Regression tests which can be run by Kyua.  See tests/README
76		for additional information.
77
78tools		Utilities for regression testing and miscellaneous tasks.
79
80usr.bin		User commands.
81
82usr.sbin	System administration commands.
83```
84
85For information on synchronizing your source tree with one or more of
86the FreeBSD Project's development branches, please see:
87
88  https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html
89