Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/franneck94/cprojecttemplate
C project template with unit-tests, documentation, ci-testing and workflows.
https://github.com/franneck94/cprojecttemplate
cmake coverage logging testing
Last synced: 8 days ago
JSON representation
C project template with unit-tests, documentation, ci-testing and workflows.
- Host: GitHub
- URL: https://github.com/franneck94/cprojecttemplate
- Owner: franneck94
- License: mit
- Created: 2022-04-03T08:06:55.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-10T08:50:22.000Z (8 months ago)
- Last Synced: 2024-10-10T19:36:38.155Z (29 days ago)
- Topics: cmake, coverage, logging, testing
- Language: CMake
- Homepage:
- Size: 204 KB
- Stars: 18
- Watchers: 4
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Template For C Projects
This is a template for C++ projects. What you get:
- Library, executable and test code separated in distinct folders.
- Use of modern CMake for building and compiling.
- External libraries fetched by CMake or cloned by Git.
- Unit testing using [Unity](https://github.com/ThrowTheSwitch/Unity)
- General purpose libraries:
- [log](https://github.com/rxi/log.c)
- [argparse](https://github.com/cofyc/argparse)
- Continuous integration testing and coverage reports with Github Actions.
- Code documentation with [Doxygen](http://www.stack.nl/~dimitri/doxygen/).
- Tooling: Clang-Format, Cmake-Format, Clang-tidy, Sanitizers
## Structure
``` text
├── CMakeLists.txt
├── app
│ ├── CMakesLists.txt
│ └── main.cc
├── cmake
│ └── cmake modules
├── docs
│ ├── Doxyfile
│ └── html/
├── external
│ ├── CMakesLists.txt
│ ├── ...
├── src
│ ├── CMakesLists.txt
│ ├── foo/
│ └── bar/
└── tests
├── CMakeLists.txt
└── main.c
```
Library code goes into [src/](src/), main program code in [app/](app) and tests go in [tests/](tests/).
## Software Requirements
- CMake 3.21+
- GNU Makefile
- Doxygen
- Conan or VCPKG
- MSVC 2017 (or higher), G++9 (or higher), Clang++9 (or higher)
- Optional: Code Coverage (only on GNU|Clang): gcovr
- Optional: Makefile, Doxygen, Conan, VCPKG
## Building
First, clone this repo and do the preliminary work:
```shell
git clone --recursive https://github.com/franneck94/CppProjectTemplate
make prepare
```
- App Executable
```shell
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build . --config Release --target main
cd app
./main
```
- Unit testing
```shell
cd build
cmake -DCMAKE_BUILD_TYPE=Debug ..
cmake --build . --config Debug --target unit_tests
cd tests
./unit_tests
```
- Documentation
```shell
cd build
cmake -DCMAKE_BUILD_TYPE=Debug ..
cmake --build . --config Debug --target docs
```
- Code Coverage (Unix only)
```shell
cd build
cmake -DCMAKE_BUILD_TYPE=Debug -DENABLE_COVERAGE=ON ..
cmake --build . --config Debug --target coverage
```
For more info about CMake see [here](./README_cmake.md).