README.md

   1 FreeBSD Source:
   2 ---------------
   3 This is the top level of the FreeBSD source directory.
   4
   5 FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms.
   6 A large community has continually developed it for more than thirty years.
   7 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.
   8
   9 For copyright information, please see [the file COPYRIGHT](COPYRIGHT) in this directory.
  10 Additional copyright information also exists for some sources in this tree - please see the specific source directories for more information.
  11
  12 The Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree.
  13 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.
  14
  15 Source Roadmap:
  16 ---------------
  17 | Directory | Description |
  18 | --------- | ----------- |
  19 | bin | System/user commands. |
  20 | cddl | Various commands and libraries under the Common Development and Distribution License. |
  21 | contrib | Packages contributed by 3rd parties. |
  22 | crypto | Cryptography stuff (see [crypto/README](crypto/README)). |
  23 | etc | Template files for /etc. |
  24 | 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 | include | System include files. |
  26 | kerberos5 | Kerberos5 (Heimdal) package. |
  27 | lib | System libraries. |
  28 | libexec | System daemons. |
  29 | release | Release building Makefile & associated tools. |
  30 | rescue | Build system for statically linked /rescue utilities. |
  31 | sbin | System commands. |
  32 | secure | Cryptographic libraries and commands. |
  33 | share | Shared resources. |
  34 | stand | Boot loader sources. |
  35 | sys | Kernel sources. |
  36 | sys/`arch`/conf | Kernel configuration files. GENERIC is the configuration used in release builds. NOTES contains documentation of all possible entries. |
  37 | tests | Regression tests which can be run by Kyua.  See [tests/README](tests/README) for additional information. |
  38 | tools | Utilities for regression testing and miscellaneous tasks. |
  39 | usr.bin | User commands. |
  40 | usr.sbin | System administration commands. |
  41
  42 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).