fprime/docs/tutorials/index.md
Thomas Boyer-Chammard 6f1369bbcf
Update docs structure for website versioning improvements (#3150)
---------

Co-authored-by: ashleynilo <ashley.k.santiago@jpl.nasa.gov>
2025-01-21 14:32:52 -08:00

56 lines
2.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
hide:
- toc
---
# Tutorials
Tutorials walk through the essentials of F Prime development, starting with the canonical HelloWorld example and progressing to cross-compiling and deploying on hardware.
<div class="grid cards" markdown>
- <span class="card-title">__Hello World__</span>
---
The Hello World tutorial shows how to create an F Prime project and how to design, implement, and test a basic F Prime component. We recommend that new users of F Prime start with this tutorial.
[View Hello World Tutorial](../../tutorials-hello-world/docs/hello-world.md){ .md-button .md-button--primary }
- <span class="card-title">__LED Blinker__</span>
---
The LED Blinker tutorial shows how to develop an F Prime project that runs on embedded hardware. It covers manager components, hardware drivers, and cross compilation, with the goal of blinking an LED on ARM hardware. This tutorial introduces the F Prime concepts of events, telemetry, commands, and parameters.
> [!NOTE]
> This tutorial can be run without hardware with the exception of section 6 “Running on Hardware”.
[View LED Blinker Tutorial](../../tutorials-led-blinker/docs/led-blinker.md){ .md-button .md-button--primary }
- <span class="card-title">__Math Component__</span>
---
The Math Component tutorial shows how to construct an F Prime application with user-defined ports and data types. It covers more advanced uses of events, telemetry, commands, and parameters. It also covers unit testing of F Prime components.
[View Math Component Tutorial](../../tutorials-math-component/docs/math-component.md){ .md-button .md-button--primary }
- <span class="card-title">__Cross-Compilation Setup Tutorial__</span>
---
Learn how to install all the dependencies required for cross-compiling for different architectures.
[View Cross-Compilation Setup Tutorial](cross-compilation.md){ .md-button .md-button--primary }
- <span class="card-title">__Arduino LED Blinker__</span>
---
This project is an implementation of the F´ LED Blinker ARM Linux Tutorial which will allow you to test on Arduino-based microcontrollers using the `fprime-arduino` toolchain instead of `fprime-arm-linux`.
[View Arduino LED Blinker Tutorial](../../tutorials-arduino-led-blinker/docs/arduino-led-blinker.md){ .md-button .md-button--primary }
</div>