Skip to content

Commit ba6627b

Browse files
authored
docs(README.md): add note about compiling with --release to ensure timing-sensitive code is correct
1 parent 2bfe7c5 commit ba6627b

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ The only prerequisites are an embedded-hal implementation that provides:
1818
See the [stm32f042 example](examples/stm32f042.rs) for a commented example of
1919
how to use the library.
2020

21+
### Release mode may be required
22+
23+
Compiling in debug mode may disturb the timing-sensitive parts of this crate and ultimately lead to failure.
24+
In this case, you will likely receive a `Timeout` error. Try compiling with `--release` instead.
25+
2126
### Tests
2227

2328
To run the tests, use something like `cargo test --lib --target x86_64-unknown-linux-gnu`.

0 commit comments

Comments
 (0)