FreeBSD/BERI is a port of the open-source FreeBSD operating system that
extends support for the Bluespec Extensible RISC implementation (BERI).
CheriBSD extends FreeBSD/BERI to implement memory protection and
software compartmentalization features supported by the CHERI ISA.
General crossbuild and use instructions for FreeBSD/BERI may be found in
the BERI Software Reference. Procedures for building and using
FreeBSD/BERI should entirely apply to CheriBSD, except as documented in
the CHERI Users Guild.

More information about BERI and CHERI can be found on
http://beri-cpu.org, http://cheri-cpu.org, in the following
Technical Reports:

Bluespec Extensible RISC Implementation: BERI Hardware reference
http://www.cl.cam.ac.uk/techreports/UCAM-CL-TR-852.html

Bluespec Extensible RISC Implementation: BERI Software reference
http://www.cl.cam.ac.uk/techreports/UCAM-CL-TR-853.html

Capability Hardware Enhanced RISC Instructions: CHERI User's guide
http://www.cl.cam.ac.uk/techreports/UCAM-CL-TR-851.html

Capability Hardware Enhanced RISC Instructions: CHERI Instruction-set
architecture
http://www.cl.cam.ac.uk/techreports/UCAM-CL-TR-850.html

---------------------------------------------------------------------------
This is the top level of the FreeBSD source directory.

For copyright information, please see the file COPYRIGHT in this
directory (additional copyright information also exists for some
sources in this tree - please see the specific source directories for
more information).

The Makefile in this directory supports a number of targets for
building components (or all) of the FreeBSD source tree.  See build(7)
and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
for more information, including setting make(1) variables.

The `buildkernel` and `installkernel` targets build and install
the kernel and the modules (see below).  Please see the top of
the Makefile in this directory for more information on the
standard build targets and compile-time flags.

Building a kernel is a somewhat more involved process.  See build(7), config(8),
and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
for more information.

Note: If you want to build and install the kernel with the
`buildkernel` and `installkernel` targets, you might need to build
world before.  More information is available in the handbook.

The kernel configuration files reside in the sys/<arch>/conf
sub-directory.  GENERIC is the default configuration used in release builds.
NOTES contains entries and documentation for all possible
devices, not just those commonly used.


Source Roadmap:
---------------

bin		System/user commands.

cddl		Various commands and libraries under the Common Development
		and Distribution License.

contrib		Packages contributed by 3rd parties.

crypto		Cryptography stuff (see crypto/README).

etc		Template files for /etc.

games		Amusements.

gnu		Various commands and libraries under the GNU Public License.
		Please see gnu/COPYING* for more information.

include		System include files.

kerberos5	Kerberos5 (Heimdal) package.

lib		System libraries.

libexec		System daemons.

release		Release building Makefile & associated tools.

rescue		Build system for statically linked /rescue utilities.

sbin		System commands.

secure		Cryptographic libraries and commands.

share		Shared resources.

sys		Kernel sources.

tests		Regression tests which can be run by Kyua.  See tests/README
		for additional information.

tools		Utilities for regression testing and miscellaneous tasks.

usr.bin		User commands.

usr.sbin	System administration commands.


For information on synchronizing your source tree with one or more of
the FreeBSD Project's development branches, please see:

  http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/synching.html