From 94ff4fbb5150ad5901b667da8eecd8afd03f1e96 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Fri, 1 Dec 2023 10:33:12 +0100 Subject: [PATCH] added coverage section in README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index a440074..1568704 100644 --- a/README.md +++ b/README.md @@ -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 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.