Updated to latest master (change of amd64 tag to x86_64).
[dragonfly.git] / README
CommitLineData
b515e798 1This is the top level of the DragonFly source directory. This file
984263bc
MD
2was last revised on:
3$FreeBSD: src/README,v 1.15.2.4 2002/04/26 16:01:35 bmah Exp $
d65c89ec 4$DragonFly: src/README,v 1.9 2008/01/27 09:08:39 nth Exp $
984263bc
MD
5
6For copyright information, please see the file COPYRIGHT in this
7directory (additional copyright information also exists for some
8sources in this tree - please see the specific source directories for
9more information).
10
11The Makefile in this directory supports a number of targets for
b515e798 12building components (or all) of the DragonFly source tree, the most
587429e4
SW
13commonly used being ``buildworld'' and ``installworld'', which rebuild
14and install everything in the DragonFly system from the source tree
15except the kernel, the kernel-modules and the contents of /etc. The
984263bc
MD
16``buildkernel'' and ``installkernel'' targets build and install
17the kernel and the modules (see below). Please see the top of
18the Makefile in this directory for more information on the
19standard build targets and compile-time flags.
20
b515e798
JR
21Building a kernel is a somewhat involved process. Documentation
22for it can be found at:
a754a615 23 http://www.dragonflybsd.org/docs/handbook/
587429e4 24Also see the the build(7) and config(8) man pages.
b515e798 25
984263bc
MD
26Note: If you want to build and install the kernel with the
27``buildkernel'' and ``installkernel'' targets, you might need to build
587429e4 28world before. More information is available in the DragonFly handbook.
984263bc 29
23e12d00 30The sample kernel configuration files reside in the sys/config
984263bc
MD
31sub-directory (assuming that you've installed the kernel sources), the
32file named GENERIC being the one used to build your initial installation
33kernel. The file LINT contains entries for all possible devices, not
34just those commonly used, and is meant more as a general reference
35than an actual kernel configuration file (a kernel built from it
36wouldn't even run).
37
38
39Source Roadmap:
40---------------
41bin System/user commands.
42
43contrib Packages contributed by 3rd parties.
44
45crypto Cryptography stuff (see crypto/README).
46
47etc Template files for /etc.
48
49games Amusements.
50
51gnu Various commands and libraries under the GNU Public License.
52 Please see gnu/COPYING* for more information.
53
54include System include files.
55
984263bc
MD
56lib System libraries.
57
58libexec System daemons.
59
b515e798
JR
60nrelease Framework for building the ``live'' CD image.
61
984263bc
MD
62sbin System commands.
63
64secure Cryptographic libraries and commands.
65
66share Shared resources.
67
68sys Kernel sources.
69
b515e798
JR
70test System tests.
71
984263bc
MD
72tools Utilities for regression testing and miscellaneous tasks.
73
74usr.bin User commands.
75
76usr.sbin System administration commands.