diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HOWTO.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/HOWTO.md b/doc/HOWTO.md index d402453..29492d5 100644 --- a/doc/HOWTO.md +++ b/doc/HOWTO.md @@ -117,6 +117,21 @@ ctest cd .. ``` +### Code Coverage (macOS only) + +To generate an HTML code coverage report for the project: + +1. **Install lcov:** + ```bash + brew install lcov + ``` + +2. **Run the coverage script:** + ```bash + ./scripts/gen_coverage_report.sh + ``` + This script will configure the build with `-DDEMO_ENABLE_COVERAGE=ON`, run the tests, and generate a report in `build_coverage/coverage_report/`. It will then attempt to open the report in your browser. + ## Tools ### Updating Submodules |