rust/spacepackets
5
1
Fork 0
Code Issues Pull Requests Projects Releases 27 Wiki Activity

added coverage section in README
Some checks failed
Rust/spacepackets/pipeline/pr-main There was a failure building this commit
Details
Rust/spacepackets/pipeline/head There was a failure building this commit
Details

Browse Source
This commit is contained in:
Robin Müller 2023-12-01 10:33:12 +01:00
parent c99b6fddec
commit 94ff4fbb51
Signed by: muellerr
GPG Key ID: A649FB78196E3849
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -47,3 +47,15 @@ deserializing them with an appropriate `serde` provider like
You can check the [documentation](https://docs.rs/spacepackets) of individual modules for various You can check the [documentation](https://docs.rs/spacepackets) of individual modules for various
usage examples. usage examples.
# Coverage
Coverage was generated using [`grcov`](https://github.com/mozilla/grcov). If you have not done so
already, install the `llvm-tools-preview`:
```sh
rustup component add llvm-tools-preview
```
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.