Skip to content

Commit 040da3b

Browse files
committed
Mention build instructions
1 parent 57f18f6 commit 040da3b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,25 @@ Operating System (RTOS). The primary target platform for this project is the Arm
66
Cortex-R5 processor, showcasing the integration of Rust with ThreadX for
77
high-performance real-time applications.
88

9+
## Build and Run
10+
11+
Visit the [Arm GNU Toolchain](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads)
12+
page and choose the AArch32 bare-metal target (`arm-none-eabi`) toolchain
13+
variant compatible with your development environment.
14+
15+
Install Rust via `rustup` (Recommended)
16+
```shell
17+
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
18+
```
19+
20+
Then, enable bare-metal target for CPUs in the Armv7-R architecture family.
21+
```shell
22+
$ rustup target add armv7r-none-eabihf
23+
```
24+
25+
Run `make` to build both ThreadX and Rust code from source.
26+
Run `make run` to launch Rust-written tasks on ThreadX via QEMU.
27+
928
## Licence
1029

1130
This project is available under a permissive MIT-style license.

0 commit comments

Comments
 (0)