1<!--
2     Copyright 2014, General Dynamics C4 Systems
3
4     SPDX-License-Identifier: GPL-2.0-only
5-->
6
7The seL4 microkernel
8====================
9
10[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5003/badge)](https://bestpractices.coreinfrastructure.org/projects/5003)
11[![CI](https://github.com/seL4/seL4/actions/workflows/push.yml/badge.svg)](https://github.com/seL4/seL4/actions/workflows/push.yml)
12[![seL4Test](https://github.com/seL4/seL4/actions/workflows/sel4test-deploy.yml/badge.svg)](https://github.com/seL4/seL4/actions/workflows/sel4test-deploy.yml)
13[![C Parser](https://github.com/seL4/seL4/actions/workflows/cparser.yml/badge.svg)](https://github.com/seL4/seL4/actions/workflows/cparser.yml)
14[![Compile](https://github.com/seL4/seL4/actions/workflows/compilation-checks.yml/badge.svg)](https://github.com/seL4/seL4/actions/workflows/compilation-checks.yml)
15[![Proof Sync](https://github.com/seL4/seL4/actions/workflows/preprocess-deploy.yml/badge.svg)](https://github.com/seL4/seL4/actions/workflows/preprocess-deploy.yml)
16[![RefMan](https://github.com/seL4/seL4/actions/workflows/manual.yml/badge.svg)](https://github.com/seL4/seL4/actions/workflows/manual.yml)
17[![XML](https://github.com/seL4/seL4/actions/workflows/xml_lint.yml/badge.svg)](https://github.com/seL4/seL4/actions/workflows/xml_lint.yml)
18
19This project contains the source code of seL4 microkernel.
20
21For details about the seL4 microkernel, including details about its formal
22correctness proof, please see the [`sel4.systems`][1] website and associated
23[FAQ][2].
24
25DOIs for citing recent releases of this repository:
26
27- [![DOI][4]](https://doi.org/10.5281/zenodo.591727)
28
29We welcome contributions to seL4. Please see the website for information
30on [how to contribute][3].
31
32This repository is usually not used in isolation, but as part of the build
33system in a larger project.
34
35  [1]: http://sel4.systems/
36  [2]: https://docs.sel4.systems/projects/sel4/frequently-asked-questions
37  [3]: https://docs.sel4.systems/processes/contributing.html
38  [4]: https://zenodo.org/badge/DOI/10.5281/zenodo.591727.svg
39  [5]: https://sel4.systems/Info/Docs/seL4-manual-latest.pdf
40  [6]: https://docs.sel4.systems/GettingStarted
41  [7]: https://docs.sel4.systems/releases/sel4
42  [8]: https://docs.sel4.systems/projects/sel4/api-doc.html
43
44seL4 Basics
45---------------
46
47- [Tutorials](https://docs.sel4.systems/Tutorials)
48- [Documentation](https://docs.sel4.systems/projects/sel4/documentation)
49- [seL4 libraries](https://docs.sel4.systems/projects/user_libs)
50- [seL4Test](https://docs.sel4.systems/projects/sel4test/)
51- [Debugging guide](https://docs.sel4.systems/projects/sel4-tutorials/debugging-guide)
52- [Benchmarking guide](https://docs.sel4.systems/projects/sel4-tutorials/benchmarking-guide.html)
53- [Virtualization on seL4](https://docs.sel4.systems/projects/virtualization/)
54- [Host Build Dependencies](https://docs.sel4.systems/projects/buildsystem/host-dependencies.html)
55- [Porting seL4](https://docs.sel4.systems/projects/sel4/porting)
56
57Community
58---------
59
60- Forums:
61  - [Discourse](https://sel4.discourse.group/)
62  - [seL4 Announce](https://lists.sel4.systems/postorius/lists/announce.sel4.systems)
63  - [seL4 Devel](https://lists.sel4.systems/postorius/lists/devel.sel4.systems)
64- [Suggested projects](https://docs.sel4.systems/SuggestedProjects)
65- [Community projects](https://docs.sel4.systems/CommunityProjects)
66
67See the [contact] links on the seL4 website for the full list.
68
69[contact]: https://sel4.systems/contact
70
71Reporting security vulnerabilities
72----------------------------------
73
74If you believe you have found a security vulnerability in seL4 or related
75software, we ask you to follow our [vulnerability disclosure policy][VDP].
76
77[VDP]: https://github.com/seL4/seL4/blob/master/SECURITY.md
78
79Manual
80------
81
82A hosted version of the [manual](manual/) for the most recent release can be found [here][5].
83
84A web version of the API can be found [here][8]
85
86Repository Overview
87-------------------
88
89- `include` and `src`: C and ASM source code of seL4
90- `tools`: build tools
91- `libsel4`: C bindings for the seL4 ABI
92- `manual`: LaTeX sources of the seL4 reference manual
93
94Build Instructions
95------------------
96
97See the seL4 website for [build instructions][6].
98
99Status
100------
101
102A list of releases and current project status can be found under [seL4 releases][7].
103
104- [Roadmap](https://docs.sel4.systems/projects/roadmap): new features in development
105- [Hardware Support](https://docs.sel4.systems/Hardware): information about hardware platform ports
106- [Kernel Features]((https://docs.sel4.systems/projects/sel4/status)): information about available
107  kernel features
108- [Userland Components and
109      Drivers](https://docs.sel4.systems/projects/available-user-components.html): available device
110      drivers and userland components
111
112License
113-------
114
115See the file [LICENSE.md](./LICENSE.md).
116