Skip to content

Template for Tachyon projects

License

Notifications You must be signed in to change notification settings

tachyon-computer/repo-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3c52867 · Jun 25, 2024

History

47 Commits
Jun 25, 2024
Nov 30, 2022
Nov 30, 2022
Feb 15, 2022
Mar 10, 2022
Nov 30, 2022
Feb 14, 2022
Feb 15, 2022
Feb 14, 2022
Feb 15, 2022
Nov 30, 2022
Feb 14, 2022
Feb 16, 2022
Feb 15, 2022
Feb 11, 2022
Feb 15, 2022
Jun 25, 2024
Jun 25, 2024

Repository files navigation

repo-template

Template for Tachyon projects

GitHub Actions   codecov   FOSSA Status   Quality Gate Status

Maintainability Rating   Reliability Rating   Technical Debt
Bugs   Code Smells   Lines of Code

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.