repo-template

Template for Tachyon projects

     

   
   

What's included

• Modern CMake skeleton (building an application and a library)
• Tests powered by Catch2 framework
• GitHub Actions CI for build and running tests
• Configuration for generating documentation with Doxygen
• pre-commit hook for checking commit message format
• pre-commit hook for checking license header
• Code formatting with clang-format
• Static code analysis with clang-tidy
• Tags generation with ctags
• Integration with codecov
• Integration with SonarCloud
• Integration with FOSSA

How to use

This is a repository template, and as such should be used as a new project starter.

However this is a completely working project, which can be build using CMake:

mkdir build && cd build
cmake -S .. -B . -G Ninja
ninja

CMake options can be configured with ccmake

License

Tachyon repository template is licensed under a 3-clause BSD license.