xref: /freebsd/README.md (revision 732a02b4e77866604a120a275c082bb6221bd2ff)
1FreeBSD Source:
2---------------
3This is the top level of the FreeBSD source directory.  This file
4was last revised on:
5$FreeBSD$
6
7FreeBSD is an operating system used to power modern servers,
8desktops, and embedded platforms. A large community has
9continually developed it for more than thirty years. Its
10advanced networking, security, and storage features have
11made FreeBSD the platform of choice for many of the
12busiest web sites and most pervasive embedded networking
13and storage devices.
14
15For copyright information, please see the file COPYRIGHT in this
16directory. Additional copyright information also exists for some
17sources in this tree - please see the specific source directories for
18more information.
19
20The Makefile in this directory supports a number of targets for
21building components (or all) of the FreeBSD source tree.  See build(7), config(8),
22https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html, and
23https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
24for more information, including setting make(1) variables.
25
26Source Roadmap:
27---------------
28```
29bin		System/user commands.
30
31cddl		Various commands and libraries under the Common Development
32		and Distribution License.
33
34contrib		Packages contributed by 3rd parties.
35
36crypto		Cryptography stuff (see crypto/README).
37
38etc		Template files for /etc.
39
40gnu		Various commands and libraries under the GNU Public License.
41		Please see gnu/COPYING* for more information.
42
43include		System include files.
44
45kerberos5	Kerberos5 (Heimdal) package.
46
47lib		System libraries.
48
49libexec		System daemons.
50
51release		Release building Makefile & associated tools.
52
53rescue		Build system for statically linked /rescue utilities.
54
55sbin		System commands.
56
57secure		Cryptographic libraries and commands.
58
59share		Shared resources.
60
61stand		Boot loader sources.
62
63sys		Kernel sources.
64
65sys/<arch>/conf Kernel configuration files. GENERIC is the configuration
66		used in release builds. NOTES contains documentation of
67		all possible entries.
68
69tests		Regression tests which can be run by Kyua.  See tests/README
70		for additional information.
71
72tools		Utilities for regression testing and miscellaneous tasks.
73
74usr.bin		User commands.
75
76usr.sbin	System administration commands.
77```
78
79For information on synchronizing your source tree with one or more of
80the FreeBSD Project's development branches, please see:
81
82  https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html
83