README.md

C++ Project Template

A modern C++ project template with a robust development environment and best practices built-in.

Features

• Development Containers for consistent development environments
• CMake build system
• GoogleTest for unit testing
• Clang-Format for code formatting

Project Structure

.
├── src/           # Source files
├── test/          # Test files
├── third_party/   # External dependencies
├── .devcontainer/ # Development container configuration
├── .github/       # GitHub Actions workflows
└── CMakeLists.txt # CMake build configuration

Getting Started

Prerequisites

• Docker Desktop
• VS Code with the Dev Containers extension
• Git

Development Setup

1. Clone this repository:

   git clone https://github.com/yourusername/cpp-project-template.git
   cd cpp-project-template

2. Initialize and update submodules:

   git submodule update --init --recursive

3. Open in VS Code:

   code .

4. When prompted, click "Reopen in Container" to start development in the containerized environment.

Building the Project

mkdir build
cd build
cmake ..
cmake --build .

Running Tests

cd build
ctest

License

This project is licensed under the MIT license.