@PROJECT_NAME@

@PROJECT_DESCRIPTION@

Build

mkdir build && cd build
cmake .. # "-UBUILD_TESTS -DBUILD_TESTS=ON" to build tests, "-ULIBRARY_TYPE -DLIBRARY_TYPE=SHARED" for building shared library
make

How to use THE LIBRARY

Download the repository and place it into your project directory. In your project's CMakeLists.txt file, insert the following lines:

...
add_subdirectory(@PROJECT_NAME@)
...
target_link_libraries(${PROJECT_NAME} @PROJECT_NAME@)
...

How to use THE EXECUTABLE

cd build
./@PROJECT_NAME@

Build documentation

doxygen

Documentation will be generated in the directory named docs.