1<!--
2     Copyright 2014, General Dynamics C4 Systems
3
4     SPDX-License-Identifier: GPL-2.0-only
5-->
6
7The seL4 microkernel
8====================
9
10This project contains the source code of seL4 microkernel.
11
12For details about the seL4 microkernel, including details about its formal
13correctness proof, please see the [`sel4.systems`][1] website and associated
14[FAQ][2].
15
16DOIs for citing recent releases of this repository:
17  * [![DOI][4]](https://doi.org/10.5281/zenodo.591727)
18
19We welcome contributions to seL4. Please see the website for information
20on [how to contribute][3].
21
22This repository is usually not used in isolation, but as part of the build
23system in a larger project.
24
25
26  [1]: http://sel4.systems/
27  [2]: https://docs.sel4.systems/projects/sel4/frequently-asked-questions
28  [3]: https://docs.sel4.systems/processes/contributing.html
29  [4]: https://zenodo.org/badge/DOI/10.5281/zenodo.591727.svg
30  [5]: https://sel4.systems/Info/Docs/seL4-manual-latest.pdf
31  [6]: https://docs.sel4.systems/GettingStarted
32  [7]: https://docs.sel4.systems/releases/sel4
33  [8]: https://docs.sel4.systems/projects/sel4/api-doc.html
34
35seL4 Basics
36---------------
37
38- [Tutorials](https://docs.sel4.systems/Tutorials)
39- [Documentation](https://docs.sel4.systems/projects/sel4/documentation)
40- [seL4 libraries](https://docs.sel4.systems/projects/user_libs)
41- [seL4Test](https://docs.sel4.systems/projects/sel4test/)
42- [Debugging guide](https://docs.sel4.systems/projects/sel4-tutorials/debugging-guide)
43- [Benchmarking guide](https://docs.sel4.systems/projects/sel4-tutorials/benchmarking-guide.html)
44- [Virtualization on seL4](https://docs.sel4.systems/projects/virtualization/)
45- [Host Build Dependencies](https://docs.sel4.systems/projects/buildsystem/host-dependencies.html)
46- [Porting seL4](https://docs.sel4.systems/projects/sel4/porting)
47
48
49Community
50---------
51
52- Mailing lists
53  - [seL4 Announce](https://lists.sel4.systems/postorius/lists/announce.sel4.systems)
54  - [seL4 Devel](https://lists.sel4.systems/postorius/lists/devel.sel4.systems)
55- [Suggested projects](https://docs.sel4.systems/SuggestedProjects)
56- [CommunityProjects](https://docs.sel4.systems/CommunityProjects)
57
58
59Manual
60------
61
62A hosted version of the [manual](manual/) for the most recent release can be found [here][5].
63
64A web version of the API can be found [here][8]
65
66Repository Overview
67-------------------
68
69  * `include` and `src`: C and ASM source code of seL4
70  * `tools`: build tools
71  * `libsel4`: C bindings for the seL4 ABI
72  * `manual`: LaTeX sources of the seL4 reference manual
73
74
75Build Instructions
76------------------
77
78See the seL4 website for [build instructions][6].
79
80
81Status
82------
83
84A list of releases and current project status can be found under [seL4 releases][7].
85
86- [Roadmap](https://docs.sel4.systems/projects/roadmap): new features in development
87- [Hardware Support](https://docs.sel4.systems/Hardware): information about hardware platform ports
88- [Kernel Features]((https://docs.sel4.systems/projects/sel4/status)): information about available kernel features
89- [Userland Components and Drivers](https://docs.sel4.systems/projects/available-user-components.html): available device drivers and
90      userland components
91
92