README.md
1FreeBSD Source:
2---------------
3This is the top level of the FreeBSD source directory.
4
5FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms.
6A large community has continually developed it for more than thirty years.
7Its 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.
8
9For copyright information, please see [the file COPYRIGHT](COPYRIGHT) in this directory.
10Additional copyright information also exists for some sources in this tree - please see the specific source directories for more information.
11
12The Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree.
13See build(7), config(8), [FreeBSD handbook on building userland](https://docs.freebsd.org/en/books/handbook/cutting-edge/#makeworld), and [Handbook for kernels](https://docs.freebsd.org/en/books/handbook/kernelconfig/) for more information, including setting make(1) variables.
14
15For information on the CPU architectures and platforms supported by FreeBSD, see the [FreeBSD
16website's Platforms page](https://www.freebsd.org/platforms/).
17
18Source Roadmap:
19---------------
20| Directory | Description |
21| --------- | ----------- |
22| bin | System/user commands. |
23| cddl | Various commands and libraries under the Common Development and Distribution License. |
24| contrib | Packages contributed by 3rd parties. |
25| crypto | Cryptography stuff (see [crypto/README](crypto/README)). |
26| etc | Template files for /etc. |
27| gnu | Commands and libraries under the GNU General Public License (GPL) or Lesser General Public License (LGPL). Please see [gnu/COPYING](gnu/COPYING) and [gnu/COPYING.LIB](gnu/COPYING.LIB) for more information. |
28| include | System include files. |
29| kerberos5 | Kerberos5 (Heimdal) package. |
30| lib | System libraries. |
31| libexec | System daemons. |
32| release | Release building Makefile & associated tools. |
33| rescue | Build system for statically linked /rescue utilities. |
34| sbin | System commands. |
35| secure | Cryptographic libraries and commands. |
36| share | Shared resources. |
37| stand | Boot loader sources. |
38| sys | Kernel sources (see [sys/README.md](sys/README.md)). |
39| targets | Support for experimental `DIRDEPS_BUILD` |
40| tests | Regression tests which can be run by Kyua. See [tests/README](tests/README) for additional information. |
41| tools | Utilities for regression testing and miscellaneous tasks. |
42| usr.bin | User commands. |
43| usr.sbin | System administration commands. |
44
45For information on synchronizing your source tree with one or more of the FreeBSD Project's development branches, please see [FreeBSD Handbook](https://docs.freebsd.org/en/books/handbook/cutting-edge/#current-stable).
46