README revision 64047
1This is the top level of the FreeBSD source directory.  This file
2was last revised on:
3$FreeBSD: head/README 64047 2000-07-31 09:22:50Z alex $
4
5For copyright information, please see the file COPYRIGHT in this
6directory (additional copyright information also exists for some
7sources in this tree - please see the specific source directories for
8more information).
9
10The Makefile in this directory supports a number of targets for
11building components (or all) of the FreeBSD source tree, the most
12commonly used one being ``world'', which rebuilds and installs
13everything in the FreeBSD system from the source tree except the
14kernel, the kernel-modules and the contents of /etc.  The
15``buildkernel'' and ``installkernel'' targets build and install
16the kernel and the modules.  Please see the top of the Makefile
17in this directory for more information on the standard build targets
18and compile-time flags.
19
20Building a kernel with config(8) is a somewhat more involved process,
21documentation for which can be found at:
22   http://www.freebsd.org/handbook/kernelconfig.html
23And in the config(8) man page.
24
25The sample kernel configuration files reside in the sys/i386/conf
26sub-directory (assuming that you've installed the kernel sources), the
27file named GENERIC being the one used to build your initial installation
28kernel.  The file NOTES contains entries and documentation for all possible
29devices, not just those commonly used.  It is the successor of the ancient
30LINT file, but in contrast to LINT, it is not buildable as a kernel but a
31pure reference and documentation file.
32
33
34Source Roadmap:
35---------------
36bin		System/User commands.
37
38contrib		Packages contributed by 3rd parties.
39
40crypto		Cryptography stuff (see crypto/README).
41
42etc		Template files for /etc
43
44games		Amusements.
45
46gnu		Various commands and libraries under the GNU Public License.
47		Please see gnu/COPYING* for more information.
48
49include		System include files.
50
51kerberosIV	Kerberos package.
52
53lib		System libraries.
54
55libexec		System daemons.
56
57release		Release building Makefile & associated tools.
58
59sbin		System commands.
60
61secure		DES and DES-related utilities - NOT FOR EXPORT!
62
63share		Shared resources.
64
65sys		Kernel sources.
66
67tools		Utilities for regression testing and miscellaneous tasks.
68
69usr.bin		User commands.
70
71usr.sbin	System administration commands.
72
73
74For information on synchronizing your source tree with one or more of
75the FreeBSD Project's development branches, please see:
76
77  http://www.freebsd.org/handbook/synching.html
78