manual/README.md: include API doc generation

Migrate documentation of the API docs generation process here from the docsite where it is too much out of view. Here it is closer to where it is needed an more likely to get updated when things change.

Compared to the docsite version, this has applied:

standard wrap column
markdown lints
adjusted headings
object-api-sel4-arch.xml etc renames
include RISC-V in structure

Signed-off-by: Gerwin Klein gerwin.klein@proofcraft.systems

The seL4 microkernel

This project contains the source code of seL4 microkernel.

For details about the seL4 microkernel, including details about its formal correctness proof, please see the sel4.systems website and associated FAQ.

DOIs for citing recent releases of this repository:

We welcome contributions to seL4. Please see the website for information on how to contribute.

This repository is usually not used in isolation, but as part of the build system in a larger project.

seL4 Basics

Community

Forums:

See also the contact links on the seL4 website.

Reporting security vulnerabilities

If you believe you have found a security vulnerability in seL4 or related software, we ask you to follow our vulnerability disclosure policy.

Manual

A hosted version of the manual for the most recent release can be found here.

A web version of the API can be found here

Repository Overview

include and src: C and ASM source code of seL4
tools: build tools
libsel4: C bindings for the seL4 ABI
manual: LaTeX sources of the seL4 reference manual

Build Instructions

See the seL4 website for build instructions.

Status

A list of releases and current project status can be found under seL4 releases.

Roadmap: new features in development
Hardware Support: information about hardware platform ports
Kernel Features: information about available kernel features

[Userland Components and

Drivers](https://docs.sel4.systems/projects/available-user-components.html): available device
drivers and userland components

License

See the file LICENSE.md.