This page shows how you can build the hermite library to contribute.

Prerequisites

Building hermite requires the following software installed:

A C++11-compliant compiler
CMake >= 3.9
Doxygen (optional, documentation building is skipped if missing)

Building hermite

The following sequence of commands builds hermite. It assumes that your current working directory is the top-level directory of the freshly cloned repository:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .

The build process can be customized with the following CMake variables, which can be set by adding -D<var>={ON, OFF} to the cmake call:

HERMITE_BUILD_TESTING: Enable building of the test suite (default: ON)
HERMITE_BUILD_DOCS: Enable building the documentation (default: ON)

Testing hermite

When built according to the above explanation (with -DHERMITE_BUILD_TESTING=ON), the C++ test suite of hermite can be run using ctest from the build directory:

cd build

ctest

Documentation

hermite provides a Doxygen documentation. You can build the documentation locally by making sure that Doxygen is installed on your system and running this command from the top-level build directory:

cmake --build . --target doxygen

The web documentation can then be browsed by opening doc/html/index.html in your browser.