Welcome to Cpp Scaffold’s documentation#

A development-focused Cpp project template.

GitHub CI Status GitHub Release GitHub License pre-commit cpp Scaffold

Features#

  • Project setup and template update with copier.

  • Customizable container development environment(vscode dev container).

  • Googletest integration.

  • Vcpkg integration.

  • Standard development source layout based on cmake and configuration cmake presets.

  • Manage cmake modules using cmake-registry.

  • Lint tool pre-commit integration.

  • Sphinx integration as the sync docs tool.

🚀 Quickstart#

  1. Generate the project.

    copier copy gh:msclock/cpp-scaffold /path/to/project

  2. Navigate to the project directory and initialize a git repository.

    cd /path/to/project
git init

  3. Commit the initialized project.

    git add .
git commit -m "Init."

  4. That’s it! Feel free to focus on the coding within src folder.

📜 License#

MIT License, for more details, see the LICENSE file.

🔖 Indices and tables#