Skip to content

Commit 3ac746b

Browse files
authored
Update README.md
1 parent f0cc51c commit 3ac746b

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# probe-plotter
22

3-
A set of tools to plot values from the target to graph in rerun with minimal performance impact
3+
A set of tools to plot values from the target to graph in rerun with minimal performance impact. This project is based on code from `defmt` and `cortex_m`'s `singleton` macro. It also uses rerun for visualization.
4+
5+
* probe-plotter - The target side library
6+
* probe-plotter-tools - The host side application
47

58
```rust
69
#![no_std]
@@ -24,7 +27,10 @@ fn main() -> ! {
2427
}
2528
```
2629

27-
##### To run the tool
30+
##### Prerequisits
31+
probe-plotter uses the Rerun viewer for visualizing the graphs. Please [make sure to that installed](https://rerun.io/docs/getting-started/installing-viewer#installing-the-viewer).
32+
33+
##### To run the tool
2834

2935
```
3036
cd probe-plotter-host
@@ -35,10 +41,11 @@ So for example plotting the example in examples/simple on a Nucleo-G474RE
3541

3642
```
3743
cd examples/simple
38-
cargo run # Let it flash and then cancel to let the target continue running in the background while giving up access to the probe
44+
cargo run # Let it flash and then cancel (Ctrl+C) to let the target continue running in the background while giving up access to the probe
3945
4046
cd ../probe-plotter-tools
4147
cargo run ../examples/simple/target/thumbv7em-none-eabihf/debug/simple stm32g474retx
4248
# Rerun will open with a graph showing all created metrics objects
4349
```
44-
<img width="2880" height="1920" alt="Screenshot_20250724_015307" src="https://github.com/user-attachments/assets/b0c0a13b-f218-421b-ae75-6e0767c2a458" />
50+
51+
<img width="2880" height="1920" alt="Screenshot" src="https://github.com/user-attachments/assets/5f7f20c9-009d-42c7-9613-789ae26afe54" />

0 commit comments

Comments
 (0)