diff --git a/README.md b/README.md index 5f5abae1d..d5c77406b 100644 --- a/README.md +++ b/README.md @@ -38,29 +38,31 @@ system in a larger project. [4]: https://zenodo.org/badge/DOI/10.5281/zenodo.591727.svg [5]: https://sel4.systems/Info/Docs/seL4-manual-latest.pdf [6]: https://docs.sel4.systems/projects/buildsystem/host-dependencies.html - [7]: https://docs.sel4.systems/releases/sel4 + [7]: https://docs.sel4.systems/releases/seL4.html [8]: https://docs.sel4.systems/projects/sel4/api-doc.html seL4 Basics --------------- - [Tutorials](https://docs.sel4.systems/Tutorials) -- [Documentation](https://sel4.systems/Learn/) +- [Overview](https://sel4.systems/Learn/) +- [Doc Site](https://docs.sel4.systems/) - [seL4 libraries](https://docs.sel4.systems/projects/user_libs) - [seL4Test](https://docs.sel4.systems/projects/sel4test/) -- [Debugging guide](https://docs.sel4.systems/projects/sel4-tutorials/debugging-guide) +- [Debugging guide](https://docs.sel4.systems/projects/sel4-tutorials/debugging-guide.html) - [Benchmarking guide](https://docs.sel4.systems/projects/sel4-tutorials/benchmarking-guide.html) - [Virtualization on seL4](https://docs.sel4.systems/projects/virtualization/) - [Host Build Dependencies](https://docs.sel4.systems/projects/buildsystem/host-dependencies.html) -- [Porting seL4](https://docs.sel4.systems/projects/sel4/porting) +- [Porting seL4](https://docs.sel4.systems/projects/sel4/porting.html) Community --------- -- Forums: - - [Discourse](https://sel4.discourse.group/) - - [seL4 Announce](https://lists.sel4.systems/postorius/lists/announce.sel4.systems) - - [seL4 Devel](https://lists.sel4.systems/postorius/lists/devel.sel4.systems) +- Open-source help and support: + - [Discourse Forum](https://sel4.discourse.group/) + - [Mattermost Chat](https://mattermost.trustworthy.systems/sel4-external/) + - [seL4 announce mailing list](https://lists.sel4.systems/postorius/lists/announce.sel4.systems) + - [seL4 devel mailing list](https://lists.sel4.systems/postorius/lists/devel.sel4.systems) See also the [contact] links on the seL4 website. @@ -77,9 +79,9 @@ software, we ask you to follow our [vulnerability disclosure policy][VDP]. Manual ------ -A hosted version of the [manual](manual/) for the most recent release can be found [here][5]. +A hosted PDF version of the [manual](manual/) for the most recent release can be found [here][5]. -A web version of the API can be found [here][8] +A web version of the [API documentation][8] is available as well. Repository Overview ------------------- @@ -97,15 +99,11 @@ See the seL4 website for [build instructions][6]. Status ------ -A list of releases and current project status can be found under [seL4 releases][7]. - +- [Releases][7]: list of available seL4 releases - [Roadmap](https://sel4.systems/roadmap.html): new features in development -- [Hardware Support](https://docs.sel4.systems/Hardware): information about hardware platform ports -- [Kernel Features](https://docs.sel4.systems/projects/sel4/status): information about available - kernel features -- [Userland Components and - Drivers](https://docs.sel4.systems/projects/available-user-components.html): available device - drivers and userland components +- [Hardware Support](https://docs.sel4.systems/Hardware/): information about hardware platform ports +- [Kernel Options](https://docs.sel4.systems/projects/sel4/configurations.html): information about available + config options and features License -------