README.md

C++ Project Template

A modern, opinionated C++ project template designed to help you quickly start your next project.

Features

• Configured for Visual Studio Code.
• Consistent development environments with   Development Containers. environments.
• Build system with CMake.
• Unit testing with GoogleTest.
• Code formatting with Clang-Format.

Project Structure

.
├── src/          # Source files
├── test/         # Test files
└── third_party/  # External dependencies

Getting Started

Prerequisites

• Git
• Docker Desktop
• Visual Studio Code
• Dev Containers extension

Development Setup

1. Clone the repository:

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

2. Initialize and update submodules:

   git submodule update --init --recursive

3. Launch Visual Studio Code and open the project folder.
4. When prompted, click "Reopen in Container"
5. Start coding!

Building the Project

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

Running Tests

cd build
ctest

License

This project is licensed under the MIT License.