pre-req:

cargo install --locked mdbook-pdf

Usage

Running Tests

To run all tests for the project, use the following command:

make test

This will run the tests in release mode using cargo test --release.

Code Coverage

To generate a code coverage report in HTML format, use the following command:

make coverage

This will use cargo-tarpaulin to generate the coverage report in HTML format.

Documentation

To generate documentation for the project, you can use:

make docs

This will generate the documentation using cargo doc and will also generate a PDF version of the documentation using mdbook.

Report

To generate documentation for the project, you can use:

make report

This will compile the latex file and generate a pdf report.

Extensions

This project includes several extensions. You can run the extensions by using:

make ext1

Cleaning

To clean the project, including clearing the build artifacts and generated documentation, use:

make clean

This will remove the target directory, as well as any generated documentation and PDF files.