Skip to content

Commit

Permalink
consolidate two tutorials overview pages
Browse files Browse the repository at this point in the history
Signed-off-by: Birgit Brecknell <[email protected]>
  • Loading branch information
bbrcknl committed Aug 12, 2024
1 parent 5336a78 commit 06e6c24
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 40 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
16 changes: 14 additions & 2 deletions Tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion Tutorials/pathways.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,5 @@ Recommended tutorials
- Follow the tutorial in the default pathway up to and including MCS.

<p>
Next tutorial: <a href="seL4-overview">seL4 tutorials</a>
Next tutorial: <a href="setting-up">Setting up your machine</a>
</p>
31 changes: 0 additions & 31 deletions Tutorials/sel4-overview.md

This file was deleted.

5 changes: 1 addition & 4 deletions _data/tutorials-sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

- name: Getting started
type: header
- name: Overview of tutorials
- name: Overview
file: ""
type: file
- name: Tutorial pathways
Expand All @@ -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
Expand Down
1 change: 0 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ This documentation site is for cooperatively developing and sharing documentatio
<p>Tutorials and other material to learn about seL4.</p>
<ul>
<li><a href="/Tutorials/">Overview</a></li>
<li><a href="/Tutorials/sel4-overview">seL4</a></li>
<li><a href="/Tutorials/mcs">MCS</a></li>
<li><a href="/Tutorials/libraries-1">Libraries</a></li>
<li><a href="/Tutorials/hello-camkes-0">CAmkES</a></li>
Expand Down

0 comments on commit 06e6c24

Please sign in to comment.