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