README.md

0 - unittests & doxygen

This repo demonstrates a simple framework for unit testing and documentation. We will go over the repo dependencies, how it works, its features, and how to use it.

Dependencies

sudo apt install gcov       # Generate line data
sudo apt install gcovr      # Report generator for gcovr
sudo apt install doxygen    # Documentation generator

How does it work?

In the root directory, there is a makefile and a unittests directory. Invoking

make

This compiles all .cpp files into .o files twice. The first compilation simply builds the file with the specified flags. The second time builds with the --coverage flag and places it in the directory.

make test

This compiles everything make does and it runs the test suite.