Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feignclaims/cpp_conan_template
A C++ CMake template using Conan 2
https://github.com/feignclaims/cpp_conan_template
cmake cmake-template conan cpp project starter starter-project
Last synced: 4 months ago
JSON representation
A C++ CMake template using Conan 2
- Host: GitHub
- URL: https://github.com/feignclaims/cpp_conan_template
- Owner: FeignClaims
- License: unlicense
- Created: 2022-10-21T06:38:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T02:12:02.000Z (9 months ago)
- Last Synced: 2024-05-09T03:25:46.865Z (9 months ago)
- Topics: cmake, cmake-template, conan, cpp, project, starter, starter-project
- Language: CMake
- Homepage:
- Size: 48.8 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cpp_conan_template
[](https://github.com/FeignClaims/cpp_conan_template/actions/workflows/ci.yml)
[](https://codecov.io/gh/FeignClaims/cpp_conan_template)
[](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//.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.