diff --git a/Makefile b/Makefile index 2ba012343d..167ed6b3ba 100644 --- a/Makefile +++ b/Makefile @@ -51,7 +51,7 @@ _repos/tutes: _repos/tutes/%.md: _repos/sel4proj/sel4-tutorials/tutorials/% _repos/tutes PYTHONPATH=_repos/sel4/capdl/python-capdl-tool _repos/sel4proj/sel4-tutorials/template.py --docsite --out-dir _repos/tutes --tut-file $$(@F) -TUTORIALS:= $(filter-out index.md get-the-tutorials.md how-to.md pathways.md sel4-overview.md setting-up.md,$(notdir $(wildcard Tutorials/*.md))) +TUTORIALS:= $(filter-out index.md get-the-tutorials.md how-to.md pathways.md setting-up.md,$(notdir $(wildcard Tutorials/*.md))) tutorials: ${TUTORIALS:%=_repos/tutes/%} _generate_api_pages: $(REPOSITORIES) diff --git a/Tutorials/index.md b/Tutorials/index.md index bc71c9ca6b..24b22940b9 100644 --- a/Tutorials/index.md +++ b/Tutorials/index.md @@ -5,14 +5,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 SPDX-FileCopyrightText: 2024 seL4 Project a Series of LF Projects, LLC. redirect_from: /projects/sel4-tutorials/ --- -# Tutorials Overview +# Overview We have developed a series of tutorials to introduce seL4 and developing systems on seL4. ## List of tutorials The tutorials are split into a number of broad categories, and have been designed around developer needs. -- The [seL4 tutorials](sel4-overview) are for people keen to learn about the base mechanisms provided by the seL4 kernel. The kernel API is explained with short exercises that show basic examples. +- The [seL4 tutorials](setting-up.md) are for people keen to learn about the base mechanisms provided by the seL4 kernel. The kernel API is explained with short exercises that show basic examples. - [MCS](mcs) introduces seL4 Mixed-Criticality System extensions, which are detailed in this [paper](https://trustworthy.systems/publications/full_text/Lyons_MAH_18.pdf) and [PhD](https://github.com/pingerino/phd/blob/master/phd.pdf). @@ -24,6 +24,18 @@ The tutorials are split into a number of broad categories, and have been designe - [Rust](https://github.com/seL4/rust-sel4) allows people to write safer user-level code on top of seL4 without needing full formal verification, with a language that is receiving increasing interest and that aligns extremely well with security and safety critical embedded systems programming. +**Recommended reading** + +Note that all of these tutorials require C programming +experience and some understanding of operating systems and computer +architecture. Suggested resources for these include: + +- C programming language + - [C tutorial](https://www.cprogramming.com/tutorial/c-tutorial.html) +- Operating Systems: + - [Modern Operating Systems (book)](https://www.amazon.com/Modern-Operating-Systems-Andrew-Tanenbaum/dp/013359162X) + - [COMP3231 at UNSW](http://www.cse.unsw.edu.au/~cs3231) + ## Resources Additional resources to assist with learning: - The [seL4 manual](https://sel4.systems/Info/Docs/seL4-manual-latest.pdf) diff --git a/Tutorials/pathways.md b/Tutorials/pathways.md index 61982ca085..26ecbf49c6 100644 --- a/Tutorials/pathways.md +++ b/Tutorials/pathways.md @@ -63,5 +63,5 @@ Recommended tutorials - Follow the tutorial in the default pathway up to and including MCS.
- Next tutorial: seL4 tutorials + Next tutorial: Setting up your machine
\ No newline at end of file diff --git a/Tutorials/sel4-overview.md b/Tutorials/sel4-overview.md deleted file mode 100644 index cd3c49af22..0000000000 --- a/Tutorials/sel4-overview.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -toc: true -layout: tutorial -SPDX-License-Identifier: CC-BY-SA-4.0 -SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC. ---- - -# Overview -The seL4 tutorials are for people keen to learn about the base mechanisms provided by the seL4 kernel. The kernel API is explained with short exercises that show basic examples. - -While doing these tutorials, we recommend having access to the -- [seL4 white paper](https://sel4.systems/About/seL4-whitepaper.pdf) -- the seL4 manual -- the API references -- the [How to page](how-to), which provides links to tutorial solutions as quick references for seL4 calls and methods - -**Recommended reading** - -Note that all of these tutorials require C programming -experience and some understanding of operating systems and computer -architecture. Suggested resources for these include: - -- C programming language - - [C tutorial](https://www.cprogramming.com/tutorial/c-tutorial.html) -- Operating Systems: - - [Modern Operating Systems (book)](https://www.amazon.com/Modern-Operating-Systems-Andrew-Tanenbaum/dp/013359162X) - - [COMP3231 at UNSW](http://www.cse.unsw.edu.au/~cs3231) - -- Next tutorial: Setting up your machine -
\ No newline at end of file diff --git a/_data/tutorials-sidebar.yml b/_data/tutorials-sidebar.yml index 8c45afeff0..50918a4050 100644 --- a/_data/tutorials-sidebar.yml +++ b/_data/tutorials-sidebar.yml @@ -8,7 +8,7 @@ - name: Getting started type: header -- name: Overview of tutorials +- name: Overview file: "" type: file - name: Tutorial pathways @@ -17,9 +17,6 @@ - name: seL4 type: header -- name: Overview - file: sel4-overview - type: file - name: Setting up your machine file: setting-up type: file diff --git a/index.md b/index.md index 564c57ee72..c205f58261 100644 --- a/index.md +++ b/index.md @@ -63,7 +63,6 @@ This documentation site is for cooperatively developing and sharing documentatioTutorials and other material to learn about seL4.