c34ffd6c8b
It answers a question that someone might have when faced with the source tree for the first time, and improves discoverability of the platforms page. Reviewed by: emaste MFC after: 1 week Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D37179
46 lines
2.8 KiB
Markdown
46 lines
2.8 KiB
Markdown
FreeBSD Source:
|
|
---------------
|
|
This is the top level of the FreeBSD source directory.
|
|
|
|
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](COPYRIGHT) in this directory.
|
|
Additional copyright information also exists for some sources in this tree - please see the specific source directories for 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), 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.
|
|
|
|
For information on the CPU architectures and platforms supported by FreeBSD, see the [FreeBSD
|
|
website's Platforms page](https://www.freebsd.org/platforms/).
|
|
|
|
Source Roadmap:
|
|
---------------
|
|
| Directory | Description |
|
|
| --------- | ----------- |
|
|
| bin | System/user commands. |
|
|
| cddl | Various commands and libraries under the Common Development and Distribution License. |
|
|
| contrib | Packages contributed by 3rd parties. |
|
|
| crypto | Cryptography stuff (see [crypto/README](crypto/README)). |
|
|
| etc | Template files for /etc. |
|
|
| 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. |
|
|
| include | System include files. |
|
|
| kerberos5 | Kerberos5 (Heimdal) package. |
|
|
| lib | System libraries. |
|
|
| libexec | System daemons. |
|
|
| release | Release building Makefile & associated tools. |
|
|
| rescue | Build system for statically linked /rescue utilities. |
|
|
| sbin | System commands. |
|
|
| secure | Cryptographic libraries and commands. |
|
|
| share | Shared resources. |
|
|
| stand | Boot loader sources. |
|
|
| sys | Kernel sources (see [sys/README.md](sys/README.md)). |
|
|
| targets | Support for experimental `DIRDEPS_BUILD` |
|
|
| tests | Regression tests which can be run by Kyua. See [tests/README](tests/README) for additional information. |
|
|
| tools | Utilities for regression testing and miscellaneous tasks. |
|
|
| usr.bin | User commands. |
|
|
| usr.sbin | System administration commands. |
|
|
|
|
For 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).
|