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