/BLIB-Template

Template repository for projects based on BLIB

Primary LanguageC++

BLIB Project Template

This a template repository meant to fast track the creation of projects based on BLIB. It contains a proper directory structure, clang format, a basic gitignore, Doxygen config, CMake read to go, gtest setup, necessary submodules, and some example code to show how it all ties together.

Setup

Some nominal changes are necessary to convert this template into a project of your own. Namely:

  1. Clone all submodules with git submodule update --init --recursive
  2. Search and replace ProjectName with your own project name. It appears often in CMake files as well as in code and in Github workflows
  3. Fill in app-specific sections in code marked with // TODO - SETUP_TASK:
  4. Update the path to your compiler and any compiler settings that need changing in c_cpp_properties.json
  5. Tweak the Doxyfile and .clang-format files to your liking
  6. Create a Github access token with repo access and add to your repo with the name REPO_ACCESS_TOKEN in order to use the release workflow