Skip to content

Commit

Permalink
Add note about submodules and gcc-arm-none-eabi.
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanpallant committed Feb 8, 2024
1 parent 937ede4 commit 390a02b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,16 @@ $ DEFMT_LOG=info cargo run --release
└─ demo_app::test_task1 @ src/main.rs:95
```

## Prerequisites

FreeRTOS is downloaded in source form using a git submodule. Ensure you have fetched the submodule, e.g. with:

```sh
git submodule update --init
```

Because FreeRTOS is written in C, you will require a C compiler for your target. We compile the C code using the [`cc` crate](https://crates.io/crates/cc) which does a good job of finding an appropriate C compiler. You can download Arm's build of [GCC for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads), or your system package manager might provide `gcc-arm-none-eabi` or `arm-none-eabi-gcc` packages.

## Licence

* Copyright (c) 2024 Ferrous Systems
Expand Down

0 comments on commit 390a02b

Please sign in to comment.