xref: /src/README.md (revision 9f91b8aaf5da3b4fcf56e3e89a49b18a54b4f191)
126e87919SWarner LoshFreeBSD Source:
226e87919SWarner Losh---------------
32918e9fdSWarner LoshThis is the top level of the FreeBSD source directory.
426e87919SWarner Losh
52918e9fdSWarner LoshFreeBSD is an operating system used to power modern servers, desktops, and embedded platforms.
62918e9fdSWarner LoshA large community has continually developed it for more than thirty years.
72918e9fdSWarner 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
9e75eac2cSWarner LoshFor copyright information, please see [the file COPYRIGHT](COPYRIGHT) in this directory.
102918e9fdSWarner LoshAdditional copyright information also exists for some sources in this tree - please see the specific source directories for more information.
1126e87919SWarner Losh
122918e9fdSWarner LoshThe Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree.
13cada2b74SLi-Wen HsuSee 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.
1426e87919SWarner Losh
15c34ffd6cSMitchell HorneFor information on the CPU architectures and platforms supported by FreeBSD, see the [FreeBSD
16c34ffd6cSMitchell Hornewebsite's Platforms page](https://www.freebsd.org/platforms/).
17c34ffd6cSMitchell Horne
18*9f91b8aaSLukas R. JacksonFor official FreeBSD bootable images, see the [release page](https://download.freebsd.org/ftp/releases/ISO-IMAGES/).
19*9f91b8aaSLukas R. Jackson
2026e87919SWarner LoshSource Roadmap:
2126e87919SWarner Losh---------------
222918e9fdSWarner Losh| Directory | Description |
23aaf99805SLi-Wen Hsu| --------- | ----------- |
242918e9fdSWarner Losh| bin | System/user commands. |
252918e9fdSWarner Losh| cddl | Various commands and libraries under the Common Development and Distribution License. |
262918e9fdSWarner Losh| contrib | Packages contributed by 3rd parties. |
272918e9fdSWarner Losh| crypto | Cryptography stuff (see [crypto/README](crypto/README)). |
282918e9fdSWarner Losh| etc | Template files for /etc. |
29266cbbfcSEd Maste| 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. |
302918e9fdSWarner Losh| include | System include files. |
312918e9fdSWarner Losh| kerberos5 | Kerberos5 (Heimdal) package. |
322918e9fdSWarner Losh| lib | System libraries. |
332918e9fdSWarner Losh| libexec | System daemons. |
342918e9fdSWarner Losh| release | Release building Makefile & associated tools. |
352918e9fdSWarner Losh| rescue | Build system for statically linked /rescue utilities. |
362918e9fdSWarner Losh| sbin | System commands. |
372918e9fdSWarner Losh| secure | Cryptographic libraries and commands. |
382918e9fdSWarner Losh| share | Shared resources. |
392918e9fdSWarner Losh| stand | Boot loader sources. |
40d1087fe8SMitchell Horne| sys | Kernel sources (see [sys/README.md](sys/README.md)). |
41f0e4e021SMitchell Horne| targets | Support for experimental `DIRDEPS_BUILD` |
422918e9fdSWarner Losh| tests | Regression tests which can be run by Kyua.  See [tests/README](tests/README) for additional information. |
432918e9fdSWarner Losh| tools | Utilities for regression testing and miscellaneous tasks. |
442918e9fdSWarner Losh| usr.bin | User commands. |
452918e9fdSWarner Losh| usr.sbin | System administration commands. |
4626e87919SWarner Losh
47cada2b74SLi-Wen HsuFor 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).
48