Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/314rs/cpp_cross_plattform_template

cmake conan cpp doxygen

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/314rs/cpp_cross_plattform_template
Owner: 314rs
License: mit
Created: 2024-02-13T03:13:18.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-08-07T03:13:24.000Z (5 months ago)
Last Synced: 2024-09-27T06:42:13.276Z (3 months ago)
Topics: cmake, conan, cpp, doxygen
Language: CMake
Homepage: https://314rs.github.io/cpp_cross_plattform_template/
Size: 175 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # C++ cross-plattform template

[![CMake and CTest](https://github.com/314rs/cpp_cross_plattform_template/actions/workflows/cmake.yml/badge.svg?branch=main)](https://github.com/314rs/cpp_cross_plattform_template/actions/workflows/cmake.yml)

[![CodeQL](https://github.com/314rs/cpp_cross_plattform_template/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/314rs/cpp_cross_plattform_template/actions/workflows/codeql.yml)

![Codecov](https://img.shields.io/codecov/c/gh/314rs/cpp_cross_plattform_template?logo=codecov)

![Coveralls](https://img.shields.io/coverallsCoverage/github/314rs/cpp_cross_plattform_template?logo=coveralls)

[![doxygen](https://img.shields.io/badge/-doxygen?logo=doxygen&logoSize=auto&color=2c4aa8)](https://314rs.github.io/cpp_cross_plattform_template/)

[![GitHub License](https://img.shields.io/github/license/314rs/cpp_cross_plattform_template)](LICENSE.txt)

![GitHub Tag](https://img.shields.io/github/v/tag/314rs/cpp_cross_plattform_template?logo=github)

Some boilerplate for my C++ projects.

with:

- conan

- cmake

- ctest + googletest

- doxygen

- github actions

  - cmake + ctest

  - doxygen -> github pages

  - CodeQL

For demo purposes this template contains a very simple main and a fizz-buzz implementation. On top there is a ton of CI/CD stuff.

The version tag is auto generated with `git describe --tags --always --dirty=-dev`, which produces something of the form `tag-hash(-dev)` (e.g. `v2.3.3-2-g28ed396-dev`). This string is used as a suffix for executables and in doxygen. Therefore tags with semantic versioning are encuraged.

## Download

Download the program for your platform from the latest [build action](https://github.com/314rs/cpp_cross_plattform_template/actions/workflows/cmake.yml).

## Build yourself

### Dependencies

- CMake

- Conan

  - boost (program_options)

  - gtest

### Build

```sh

conan install conanfile.txt --build=missing

cmake -DCMAKE_TOOLCHAIN_FILE=./build/generators/conan_toolchain.cmake -S. -B./build -G "YourGeneratorHere"

cmake --build build

```

### Testing

```sh

cd build

ctest

```

## Doxygen

Doxygen documentation can be found [here](https://314rs.github.io/cpp_cross_plattform_template/).

Or build it yourself:

```sh

git clone https://github.com/jothepro/doxygen-awesome-css.git docs/doxygen-awesome-css

echo "PROJECT_NUMBER = $(git describe --tags --always --dirty=-dev)" > docs/PROJECT_NUMBER # important, always do this before running doxygen

doxygen

```

## Wiki

For further information check out the [wiki](https://github.com/314rs/cpp_cross_plattform_template/wiki).

## License

This software is open source and released under the [MIT License](LICENSE.txt).