Skip to content

Commit

Permalink
add miri chapter in README
Browse files Browse the repository at this point in the history
  • Loading branch information
robamu committed May 14, 2024
1 parent 791c7f6 commit 374c034
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,13 @@ cargo install grcov --locked

After that, you can simply run `coverage.py` to test the project with coverage. You can optionally
supply the `--open` flag to open the coverage report in your webbrowser.

# Miri

You can run the [`miri`](https://github.com/rust-lang/miri) tool on this library to check for
undefined behaviour (UB). This library does not use use any `unsafe` code blocks, but `miri` could
still catch UB from used libraries.

```sh
cargo +nightly miri nextest run --all-features
```

0 comments on commit 374c034

Please sign in to comment.