From 8e10499d44abbd435fbf467c079447b9e340e029 Mon Sep 17 00:00:00 2001 From: "Jonathan Pallant (Ferrous Systems)" Date: Mon, 30 Oct 2023 11:32:33 +0000 Subject: [PATCH] Use empty headings for missing slide decks. Requires mdslides 0.4 --- .github/workflows/build.yml | 2 +- training-slides/src/SUMMARY.md | 28 ++++++++++++++++++---------- training-slides/src/start_here.md | 9 +++++---- 3 files changed, 24 insertions(+), 15 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 9a3f5836..3f24ef4b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -15,7 +15,7 @@ jobs: - name: Install tools uses: taiki-e/install-action@v2 with: - tool: mdslides@0.3,mdbook@0.4,mdbook-mermaid@0.12 + tool: mdslides@0.4,mdbook@0.4,mdbook-mermaid@0.12 - name: Add Rust Targets run: | diff --git a/training-slides/src/SUMMARY.md b/training-slides/src/SUMMARY.md index dd370057..90180a94 100644 --- a/training-slides/src/SUMMARY.md +++ b/training-slides/src/SUMMARY.md @@ -53,36 +53,44 @@ Topics that go beyond [Applied Rust](#applied-rust). * [Testing](./testing.md) * [The stdlib](./std-lib-tour.md) * [Using Cargo](./using-cargo.md) -* [Using Types to encode State (TBC)](./type-state.md) +* [Using Types to encode State](./type-state.md) * [WASM](./wasm.md) # No-Std Rust Rust for the Linux Kernel and other no-std environments with an pre-existing C API. Requires [Applied Rust](#applied-rust). -* [Overview of no-std Rust (TBC)](./rust-no-std.md) * [Unsafe Rust](./unsafe.md) * [Foreign Function Interface](./ffi.md) * [Working with Nightly](./working-with-nighly.md) -* [Rust in the Linux Kernel (TBC)](./rust-linux-kernel.md) -* [Rust on an RTOS (TBC)](./rust-rtos.md) -* [Writing a new target (TBC)](./custom-target.md) + +## Under development + +* [Overview of no-std Rust]() +* [Rust in the Linux Kernel]() +* [Rust on an RTOS]() +* [Writing a new target]() # Bare-Metal Rust -Topics about using Rust on ARM Cortex-M Microcontrollers (and similar). Requires [Low-Level Rust](#low-level-rust). +Topics about using Rust on ARM Cortex-M Microcontrollers (and similar). Requires [Applied Rust](#applied-rust). * [Overview of Bare-Metal Rust](./rust-bare-metal.md) -* [Booting a Cortex-M Microcontroller (TBC)](./cortex-m-booting.md) -* [Exceptions and Interrupts on a Cortex-M Microcontroller (TBC)](./cortex-m-exceptions-interrupts.md) * [PACs and svd2rust](./pac-svd2rust.md) * [Writing Drivers](./writing-drivers.md) * [The Embedded HAL and its implementations](./embedded-hals.md) * [Board Support Crates](./board-support.md) -* [Using RTIC v1 (TBC)](./rtic-v1.md) + +## Under development + +* [Booting a Cortex-M Microcontroller]() +* [Exceptions and Interrupts on a Cortex-M Microcontroller]() +* [Using RTIC v1]() # Ferrocene Topics around [Ferrocene](https://ferrous-systems.com/ferrocene/), the qualified toolchain for writing safety-critical systems in Rust. -* [Installing and Using Ferrocene (TBC)](./installing-using-ferrocene.md) +## Under development + +* [Installing and Using Ferrocene]() diff --git a/training-slides/src/start_here.md b/training-slides/src/start_here.md index acc4b7a3..166a381f 100644 --- a/training-slides/src/start_here.md +++ b/training-slides/src/start_here.md @@ -4,7 +4,7 @@ Make sure to have `rustup`, `VSCode` and the `rust-analyzer` VSCode extension installed. -Our various Rust training courses fit together as follows: +Our various Rust training courses are planned to fit together as follows. Some of these courses are available now, and some are in development and will be available in the future. ```mermaid graph TD; @@ -12,11 +12,12 @@ graph TD; Applied-->Advanced(Advanced Rust); Applied-->NoStd(No-Std Rust); NoStd-->Ferrocene(Using Ferrocene); - NoStd-->BareMetal(Bare-Metal Rust); + Applied-->BareMetal(Bare-Metal Rust); Applied-->Async(Async Rust); BareMetal-->Embassy(Using Embassy); Async-->Embassy; - Why(Why Rust?); + WhyRust(Why Rust?); + WhyFerrocene(Why Ferrocene?); ``` * **Rust Fundamentals**: Covers the basics - types, writing functions, using iterators. @@ -28,4 +29,4 @@ graph TD; * **Bare-Metal Rust**: Rust on a micro-controller. * **Using Embassy**: Async-Rust on a micro-controller. * **Why Rust?**: A (stand-alone) half-day tour of Rust for decision-makers, technical leads and managers. - +* **Why Ferrocene?**: A (stand-alone) 90 minute tour of Ferrocene.