diff --git a/docs/Tutorials/README.md b/docs/Tutorials/README.md index a1ade489be..de4086583f 100644 --- a/docs/Tutorials/README.md +++ b/docs/Tutorials/README.md @@ -8,13 +8,14 @@ users to learn F´ and walk through the most basic steps in developing an F´ ap ## Tutorials Index -1. [HelloWorld](HelloWorld/Tutorial.md) -2. [MathComponent](MathComponent/Tutorial.md) -3. [Cross-Compilation Tutorial](CrossCompilation/Tutorial.md) +1. [HelloWorld](HelloWorld/Tutorial.md): An Introduction to F´ +2. [LedBlinker](https://github.com/fprime-community/fprime-workshop-led-blinker/blob/main/README.md): F´ and Embedded Hardware +3. [MathComponent](MathComponent/Tutorial.md) +4. [Cross-Compilation Tutorial](CrossCompilation/Tutorial.md) -## [HelloWorld](HelloWorld/Tutorial.md) +## [HelloWorld](HelloWorld/Tutorial.md): An Introduction to F´ -The getting started tutorial walks a new user through creating a new project, their first F´ component, and testing that +The HelloWorld tutorial walks a new user through creating a new project, their first F´ component, and testing that component through an F´ deployment. This tutorial has the following subsections: 1. [Introduction and F´ Terminology](./HelloWorld/Tutorial.md) @@ -22,22 +23,21 @@ component through an F´ deployment. This tutorial has the following subsections 3. [Creating an F´ Hello World Component](./HelloWorld/HelloWorld.md) 4. [Integration and Testing With F´ Deployments](./HelloWorld/Deployments.md) -## [Math Component](MathComponent/Tutorial.md) - -A tutorial to walk through the full development process of an F´ application. It does this by creating two components, -one to request the results of a math operation, and the other to compute the result. This allows users to see F´ -components communicate and run and F´ project without the need for embedded devices nor hardware. This tutorial runs entirely -on a user's *nix (Linux, Mac, BSD, Windows w/ WSL) machine. It uses the existing `Ref` application as a host for the components -allowing a quick development. Users should first review the [Getting Started Tutorial](HelloWorld/Tutorial.md) for -understanding the tools. - -## [Cross-Compilation Tutorial](CrossCompilation/Tutorial.md) - -A tutorial that walks the user through the process of cross-compiling a -complete Math Component application to the Raspberry Pi. This allows users to -gain a basic understanding of how to cross-compile an F´ application and run -the deployment on the Raspberry Pi. To get the most from this tutorial the user -should possess a Raspberry Pi. Users should first review the -[Getting Started Tutorial](HelloWorld/Tutorial.md) for understanding the -tools and complete the [Math Component Tutorial](MathComponent/Tutorial.md) to -build familiarity with F´ and to have a complete Ref application. +## [LedBlinker](https://github.com/fprime-community/fprime-workshop-led-blinker/blob/main/README.md): F´ and Embedded Hardware + +LedBlinker walks users through developing an F´ project intended for running on embedded hardware. It covers manager components, hardware drivers, and cross-compilation with the goal of blinking an LED on ARM hardware. Events, Telemetry, Commands, and Parameters are covered as well. + +> This tutorial can be run without hardware with the exception of section 6 "Running on Hardware". + +1. [Project Setup](https://github.com/fprime-community/fprime-workshop-led-blinker/blob/main/docs/project-setup.md) +2. [Component Design and Initial Implementation](https://github.com/fprime-community/fprime-workshop-led-blinker/blob/main/docs/component-implementation-1.md) +3. [Initial Component Integration](https://github.com/fprime-community/fprime-workshop-led-blinker/blob/main/docs/initial-integration.md) +4. [Continuing Component Implementation](https://github.com/fprime-community/fprime-workshop-led-blinker/blob/main/docs/component-implementation-2.md) +5. [Full System Integration](https://github.com/fprime-community/fprime-workshop-led-blinker/blob/main/docs/full-integration.md) +6. [Running on Hardware](https://github.com/fprime-community/fprime-workshop-led-blinker/blob/main/docs/running-on-hardware.md) +7. [Unit-Testing](https://github.com/fprime-community/fprime-workshop-led-blinker/blob/main/docs/unit-testing.md) +8. [System Testing](https://github.com/fprime-community/fprime-workshop-led-blinker/blob/main/docs/system-testing.md) + +## [MathComponent](MathComponent/Tutorial.md): Custom Ports and Types + +MathComponent tutorial walks users through constructing a full F´ application including custom Ports, and Enumeration data types. Events, Telemetry, Commands, and Parameters are covered as well. Unit-Testing is also covered.