Skip to content

Commit 5337d61

Browse files
jdharumanJayachandran Dharuman
andauthored
Updated FreeRTOS-Rust Linux setup instruction information in README doc (#83)
* Updated FreeRTOS-Rust Linux setup instruction information in README doc * Removed mut keyword from Freertos hook set_on_assert() callback register * Reverted the changes --------- Co-authored-by: Jayachandran Dharuman <[email protected]>
1 parent ee789cf commit 5337d61

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

freertos-rust-examples/README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Setup
44

5-
We need to use nightly toolchain to support all examples.
5+
We need to use nightly toolchain to support all examples.
66
Even if some might run with the stable toolchain as well.
77

88
**GNU Toolchain** is required for debugging some examples (e.g. windows):
@@ -46,7 +46,7 @@ To see all errors use:
4646

4747
### Run Windows Demo
4848

49-
You need to build with nightly GNU to allow debugging.
49+
You need to build with nightly GNU to allow debugging.
5050
The target must be `x86_64-pc-windows-msvc` for the FreeRTOS `MSVC-MingW` port.
5151

5252
Prepare the build with:
@@ -60,14 +60,22 @@ Run the build
6060

6161
### Run Linux Demo
6262

63-
6463
Prepare the build with:
6564

66-
rustup default x86_64-unknown-linux-gnu
65+
rustup default nightly
66+
rustup toolchain install nightly
6767
rustup target add x86_64-unknown-linux-gnu
68-
68+
rustup component add llvm-tools-preview
69+
cargo install cargo-binutils
70+
71+
sudo apt install gcc g++ make
72+
6973
Run the build
7074

75+
cargo build --package freertos-rust-examples --example linux --target x86_64-unknown-linux-gnu
76+
77+
Run the example
78+
7179
cargo run --package freertos-rust-examples --example linux --target x86_64-unknown-linux-gnu
7280

7381
### Run STM32 Cortex-M3 Demo
@@ -126,21 +134,21 @@ Create the Toolchain under: `File | Settings | Build, Execution, Deployment | To
126134
* Name: `arm-none-eabi`
127135
* Debugger: `/path/to/arm-none-eabi-gdb.exe`
128136

129-
Build:
137+
Build:
130138

131139
* Name: `build-nrf9160-example`
132140
* Programm: `cargo`
133141
* Arguments: `build --package freertos-rust-examples --example nrf9160 --target thumbv8m.main-none-eabihf`
134142
* Working directory: `$ProjectFileDir$`
135143

136-
Clean:
144+
Clean:
137145

138146
* Name: `clean`
139147
* Programm: `cargo`
140148
* Arguments: `clean`
141149
* Working directory: `$ProjectFileDir$`
142150

143-
Setup a Run Configuration:
151+
Setup a Run Configuration:
144152

145153
* Executable: `target\thumbv8m.main-none-eabihf\debug\examples\nrf9160` (only selectable after first build!)
146154
* Download executable: `Always`

0 commit comments

Comments
 (0)