Skip to content

Commit 5e44b15

Browse files
committed
Overhaul docs
The docs were not good before. Also they became heavily out of date over time. I've reduced their verbosity as much as I could, and moved as much of the explanations of things to comments and the tops of modules.
1 parent 71254c6 commit 5e44b15

26 files changed

Lines changed: 286 additions & 642 deletions

File tree

controlSystem/RecoveryBoard/firmware-rs/README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Embassy requires Rust nightly, but `rust-toolchain.toml` should handle this for
77

88
You will also need to install the target platform:
99

10-
```bash
10+
```sh
1111
rustup target add thumbv6m-none-eabi
1212
```
1313

@@ -19,15 +19,15 @@ In this case, you may need to build probe-rs from source.
1919

2020
With all the dependencies installed, you should now be able to navigate to the directory containing the Cargo.toml file and run:
2121

22-
```rust
22+
```sh
2323
cargo run --bin blinky --release
2424
```
2525

2626
If you are flashing blinky directly onto one of the ERS boards, you will need to set the BOARD environment variable to `"main"`.
2727

2828
After it builds, terminal output should look like this if everything went according to plan:
2929

30-
```bash
30+
```sh
3131
Finished `release` profile [optimized + debuginfo] target(s) in 0.21s
3232
Running `probe-rs run --chip STM32F091RCTX target/thumbv6m-none-eabi/release/blinky`
3333
Erasing ✔ 100% [####################] 16.00 KiB @ 46.76 KiB/s (took 0s)
@@ -46,7 +46,7 @@ and the led should be blinking.
4646
If you are planning on flashing, you can just call the commands in the Flashing section after this and building will be handled automatically.
4747
If you need to build separately for some reason, run:
4848
49-
```bash
49+
```sh
5050
cargo build -r --bin blinky
5151
```
5252
@@ -58,18 +58,30 @@ The commands to flash the binaries are as follows:
5858
5959
*Sender*:
6060
61-
```rust
61+
```sh
6262
cargo sender
6363
```
6464
6565
*Drogue parachute*:
6666
67-
```rust
67+
```sh
6868
BOARD=drogue cargo parachute
6969
```
7070
7171
*Main parachute*:
7272
73-
```rust
73+
```sh
7474
BOARD=main cargo parachute
7575
```
76+
77+
## Note on CLI usage with picocom
78+
79+
Be sure to configure picocom to remap outgoing deletes to backspaces, or you will not be able to backspace properly.
80+
81+
Example command:
82+
83+
```sh
84+
picocom -b 115200 -e "b" /dev/tty{USB0} --omap delbs
85+
```
86+
87+
Replace {USB0} with where the device has been enumerated to

0 commit comments

Comments
 (0)