README.md

   1 FreeBSD Source:
   2 ---------------
   3 This is the top level of the FreeBSD source directory.  This file
   4 was last revised on:
   5 $FreeBSD$
   6
   7 For copyright information, please see the file COPYRIGHT in this
   8 directory (additional copyright information also exists for some
   9 sources in this tree - please see the specific source directories for
  10 more information).
  11
  12 The Makefile in this directory supports a number of targets for
  13 building components (or all) of the FreeBSD source tree.  See build(7)
  14 and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
  15 for more information, including setting make(1) variables.
  16
  17 The `buildkernel` and `installkernel` targets build and install
  18 the kernel and the modules (see below).  Please see the top of
  19 the Makefile in this directory for more information on the
  20 standard build targets and compile-time flags.
  21
  22 Building a kernel is a somewhat more involved process.  See build(7), config(8),
  23 and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
  24 for more information.
  25
  26 Note: If you want to build and install the kernel with the
  27 `buildkernel` and `installkernel` targets, you might need to build
  28 world before.  More information is available in the handbook.
  29
  30 The kernel configuration files reside in the `sys/<arch>/conf`
  31 sub-directory.  GENERIC is the default configuration used in release builds.
  32 NOTES contains entries and documentation for all possible
  33 devices, not just those commonly used.
  34
  35
  36 Source Roadmap:
  37 ---------------
  38 ```
  39 bin             System/user commands.
  40
  41 cddl            Various commands and libraries under the Common Development
  42                 and Distribution License.
  43
  44 contrib         Packages contributed by 3rd parties.
  45
  46 crypto          Cryptography stuff (see crypto/README).
  47
  48 etc             Template files for /etc.
  49
  50 gnu             Various commands and libraries under the GNU Public License.
  51                 Please see gnu/COPYING* for more information.
  52
  53 include         System include files.
  54
  55 kerberos5       Kerberos5 (Heimdal) package.
  56
  57 lib             System libraries.
  58
  59 libexec         System daemons.
  60
  61 release         Release building Makefile & associated tools.
  62
  63 rescue          Build system for statically linked /rescue utilities.
  64
  65 sbin            System commands.
  66
  67 secure          Cryptographic libraries and commands.
  68
  69 share           Shared resources.
  70
  71 stand           Boot loader sources.
  72
  73 sys             Kernel sources.
  74
  75 tests           Regression tests which can be run by Kyua.  See tests/README
  76                 for additional information.
  77
  78 tools           Utilities for regression testing and miscellaneous tasks.
  79
  80 usr.bin         User commands.
  81
  82 usr.sbin        System administration commands.
  83 ```
  84
  85 For information on synchronizing your source tree with one or more of
  86 the FreeBSD Project's development branches, please see:
  87
  88   https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html