xref: /src/README.md (revision 2918e9fdb82ffe5e95cab90a754bc6c2b6dd16a2)
126e87919SWarner LoshFreeBSD Source:
226e87919SWarner Losh---------------
3*2918e9fdSWarner LoshThis is the top level of the FreeBSD source directory.
426e87919SWarner Losh
5*2918e9fdSWarner LoshFreeBSD is an operating system used to power modern servers, desktops, and embedded platforms.
6*2918e9fdSWarner LoshA large community has continually developed it for more than thirty years.
7*2918e9fdSWarner LoshIts 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.
87c063179SEitan Adler
9*2918e9fdSWarner LoshFor copyright information, please see the file COPYRIGHT in this directory.
10*2918e9fdSWarner LoshAdditional copyright information also exists for some sources in this tree - please see the specific source directories for more information.
1126e87919SWarner Losh
12*2918e9fdSWarner LoshThe Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree.
13*2918e9fdSWarner LoshSee build(7), config(8), [FreeBSD handbook on building userland](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html), and [Handbook for kernels](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html) for more information, including setting make(1) variables.
1426e87919SWarner Losh
1526e87919SWarner LoshSource Roadmap:
1626e87919SWarner Losh---------------
17*2918e9fdSWarner Losh| Directory | Description |
18*2918e9fdSWarner Losh| --------- | ------------ |
19*2918e9fdSWarner Losh| bin | System/user commands. |
20*2918e9fdSWarner Losh| cddl | Various commands and libraries under the Common Development and Distribution License. |
21*2918e9fdSWarner Losh| contrib | Packages contributed by 3rd parties. |
22*2918e9fdSWarner Losh| crypto | Cryptography stuff (see [crypto/README](crypto/README)). |
23*2918e9fdSWarner Losh| etc | Template files for /etc. |
24*2918e9fdSWarner Losh| gnu | Various commands and libraries under the GNU Public License. Please see [gnu/COPYING](gnu/COPYING) and [gnu/COPYING.LIB](gnu/COPYING.LIB) for more information. |
25*2918e9fdSWarner Losh| include | System include files. |
26*2918e9fdSWarner Losh| kerberos5 | Kerberos5 (Heimdal) package. |
27*2918e9fdSWarner Losh| lib | System libraries. |
28*2918e9fdSWarner Losh| libexec | System daemons. |
29*2918e9fdSWarner Losh| release | Release building Makefile & associated tools. |
30*2918e9fdSWarner Losh| rescue | Build system for statically linked /rescue utilities. |
31*2918e9fdSWarner Losh| sbin | System commands. |
32*2918e9fdSWarner Losh| secure | Cryptographic libraries and commands. |
33*2918e9fdSWarner Losh| share | Shared resources. |
34*2918e9fdSWarner Losh| stand | Boot loader sources. |
35*2918e9fdSWarner Losh| sys | Kernel sources. |
36*2918e9fdSWarner Losh| sys/<arch>/conf | Kernel configuration files. GENERIC is the configuration used in release builds. NOTES contains documentation of all possible entries. |
37*2918e9fdSWarner Losh| tests | Regression tests which can be run by Kyua.  See [tests/README](tests/README) for additional information. |
38*2918e9fdSWarner Losh| tools | Utilities for regression testing and miscellaneous tasks. |
39*2918e9fdSWarner Losh| usr.bin | User commands. |
40*2918e9fdSWarner Losh| usr.sbin | System administration commands. |
4126e87919SWarner Losh
42*2918e9fdSWarner LoshFor information on synchronizing your source tree with one or more of the FreeBSD Project's development branches, please see [FreeBSD Handbook](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html).
43