ProjGeom

Adjust the template to your needs

• Use this repo as a template.
• Replace all occurrences of "ProjGeom" in the relevant CMakeLists.txt with the name of your project
  • Capitalization matters here: ProjGeom means the name of the project, while projgeom is used in file names.
  • Remember to rename the include/projgeom directory to use your project's lowercase name and update all relevant #includes accordingly.
• Replace the source files with your own
• For header-only libraries: see the comments in CMakeLists.txt
• Add your project's codecov token to your project's github secrets under CODECOV_TOKEN
• Happy coding!

Eventually, you can remove any unused files, such as the standalone directory or irrelevant github workflows for your project. Feel free to replace the License with one suited for your project.

To cleanly separate the library and subproject code, the outer CMakeList.txt only defines the library itself while the tests and other subprojects are self-contained in their own directories. During development it is usually convenient to build all subprojects at once.

Build and run the standalone target

Use the following command to build and run the executable target.

cmake -S. -B build
cmake --build build
./build/standalone/ProjGeom --help

Build and run test suite

Use the following commands from the project's root directory to run the test suite.

cmake -S. -B build
cmake --build build
cd build/test
CTEST_OUTPUT_ON_FAILURE=1 ctest

# or maybe simply call the executable:
./build/test/ProjGeomTests

To collect code coverage information, run CMake with the -DENABLE_TEST_COVERAGE=1 option.

Run clang-format

Use the following commands from the project's root directory to check and fix C++ and CMake source style. This requires clang-format, cmake-format and pyyaml to be installed on the current system.

cmake -S . -B build/test

# view changes
cmake --build build --target format

# apply changes
cmake --build build --target fix-format

See Format.cmake for details.

Build the documentation

The documentation is automatically built and published whenever a GitHub Release is created. To manually build documentation, call the following command.

cmake -S . -B build
cmake --build build --target GenerateDocs
# view the docs
open build/documentation/doxygen/html/index.html

To build the documentation locally, you will need Doxygen, jinja2 and Pygments on installed your system.

Additional tools

The test and standalone subprojects include the tools.cmake file which is used to import additional tools on-demand through CMake configuration arguments. The following are currently supported.