Template C++

A modular C++ project using a component-based architecture, with CMake as the build system and Conan for dependency management.

• 1. Details
  • 1.1. Prerequisites
• 2. Contribute
• 3. Troubleshoot
  • 3.1. TODO
• 4. References

1. Details

1.1. Prerequisites

• Git

  Distributed version control system for tracking source code changes.

  sudo apt install git
  

• Git LFS

  Git extension for managing large files (assets, binaries) outside normal Git history.

  sudo apt install git-lfs
  git lfs install
  

• Make

  Task automation tool to manage build processes and workflows.

  sudo apt install make
  

2. Contribute

CONTRIBUTING.md provides guidens and instructions for contributing to the project.

• AI Agents

  Automated tools that assist in various development tasks such as code generation, testing, and documentation.

• Skills Manager

  CLI tool for managing AI agent skills in development projects.

• Task Runner

  Make automation tool that defines and manages tasks to streamline development workflows.

• Bootstrap

  Scripts to bootstrap, setup, and teardown a software development workspace with requisites.

• Dev Containers

  Consistent development environments using Docker containers.

• Build System

  CMake build system configuration and presets for building the project.

• Dependency Manager

  Conan package manager configuration for managing project dependencies and packages.

• Software Testing

  Unit tests, coverage, and sanitizers for ensuring code quality and reliability.

• Cache Manager

  Compiler cache configuration to speed up rebuilds.

• Release Manager

  Semantic-Release automates the release process by analyzing commit messages.

• Update Manager

  Renovate and Dependabot automate dependency updates by creating pull requests.

• Secrets Manager

  SOPS for managing and encrypting sensitive data such as passwords, API keys, and other secrets.

• Container Manager

  Docker containerization tool to run applications in isolated container environments.

• Policy Manager

  Conftest for policy-as-code enforcement.

• Supply Chain Manager

  Trivy for security scanning of vulnerabilities, misconfigurations, and compliance issues.

• Documentation Generators

  Doxygen for generating API documentation from annotated source code.

3. Troubleshoot

3.1. TODO

TODO

4. References

• Sentenz Template DX repository.
• Sentenz Template C++ repository.
• Sentenz Actions repository.
• Sentenz Manager Tools article.
• Sentenz Skills repository.