Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
IvanDyachenko committed Feb 9, 2025
1 parent b60fe02 commit 09cf33d
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,38 @@
# STM32F0 Crankshaft Monitor

Real-time crankshaft sensor monitoring system built with Rust and [embassy-rs](https://github.com/embassy-rs) framework for STM32F0 microcontrollers.

## Useful Commands

### Development

- Run with debug features using `probe-run`:
```bash
cargo run --profile dev --bin crankshaft
```

### Analysis

- Analyze binary size with detailed section breakdown:
```bash
cargo size --bin crankshaft --release --no-default-features -- -A
```

- Inspect read-only data section:
```bash
cargo objdump --bin crankshaft --release --no-default-features -- -s -j .rodata | vi
```

> **Note**: Using `--no-default-features` disables debug functionality for smaller binary size and better performance.
### Release

- Flash release build:
```bash
cargo embed --release --bin crankshaft --no-default-features
```

- Run release build:
```bash
cargo run --profile release --bin crankshaft --no-default-features
```

0 comments on commit 09cf33d

Please sign in to comment.