# cpp_conan_template

**Repository Path**: cpp_tutorial/cpp_conan_template

## Basic Information

- **Project Name**: cpp_conan_template
- **Description**: A C++ CMake template using Conan 2
- **Primary Language**: Unknown
- **License**: Unlicense
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-05-08
- **Last Updated**: 2025-09-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cpp_conan_template

[![ci](https://github.com/FeignClaims/cpp_conan_template/actions/workflows/ci.yml/badge.svg)](https://github.com/FeignClaims/cpp_conan_template/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/FeignClaims/cpp_conan_template/graph/badge.svg?token=BQEOMHO4P6)](https://codecov.io/gh/FeignClaims/cpp_conan_template)
[![CodeQL](https://github.com/FeignClaims/cpp_conan_template/actions/workflows/codeql.yml/badge.svg)](https://github.com/FeignClaims/cpp_conan_template/actions/workflows/codeql.yml)

> Write your own conan profile and conanfile, then use cmake with the generated toochians.

:warning: support for docker images dose NOT complete yet!

## About cpp_conan_template

This is a cmake template using conan 2.0 for setting up and running with C++ quickly.

This repository highly depends on [aminya/project_options](https://github.com/aminya/project_options), which improves the CMake experience a lot.

It includes:

- a basic example on how to manage dependencies using conan and use it simply
- an example github action testing working on Linux/MacOS/Windows
- examples for testing using [catchorg/Catch2]([https://github.com/boost-ext/ut](https://github.com/catchorg/Catch2))

It requires:

- cmake 3.25+
- conan 2.0.15+
- a C++ compiler that supports C++20.
- (optional) ccache
- (optional) clang-tidy
- (optional) clang-format
- (optional) cppcheck

## Getting Started

### Use the Github template

First, click the green `Use this template` button near the top of this page.
This will take you to Github's ['Generate Repository'](https://github.com/FeignClaims/cpp_conan_template/generate) page.
Fill in a repository name and short description, and click 'Create repository from template'.
This will allow you to create a new repository in your Github account,
prepopulated with the contents of this project.

Now you can clone the project locally and get to work!

```bash
git clone https://github.com/<user>/<your_new_repo>.git
```

### Docs

- [Dependencies Setup](./README_dependencies.md)
- [Usage](./README_usage.md)
- [File Structure](./README_structure.md)
- [Useful References](./README_references.md)

## More Details

This repository highly depends on [aminya/project_options](https://github.com/aminya/project_options), which improves the CMake experience a lot.

I learnt CMake from scrach using [*Modern CMake for C++*](https://github.com/PacktPublishing/Modern-CMake-for-Cpp).

For conan 2.0, [here](https://docs.conan.io/2.0/index.html) is the official documentation.