9927438c64
|
||
|---|---|---|
| .template_files | ||
| build | ||
| cmake/cmocka | ||
| docs | ||
| inc | ||
| src | ||
| tests | ||
| toolchains | ||
| .gitignore | ||
| CMakeLists.txt | ||
| Doxyfile | ||
| LICENSE | ||
| README.md | ||
| otto.sh | ||
| setup.sh | ||
README.md
cmake-cmocka-template
A template for C and CPP programming that makes use of the cmocka unit testing framework in addition to the CMAKE build system.
Requirements
Resources
Documentation
Documentation genreation is handled with Doxygen.
Building documentation
doxygen ./Doxyfile
# Magic happens
ls ./docs
And that's it.
Contributions
Directory Overview
It's focused on wide compatibility with multiple systems and setup for vim usage..
tree -L 2 ./
├── build
├── CMakeLists.txt
├── docs
├── inc
├── LICENSE
├── README.md
├── setup.sh
├── src
│ ├── CMakeLists.txt
│ └── main.c
├── otto.sh
└── tests
└── CMakeLists.txt
5 directories, 8 files
Scripts
There are two scripts setup inside the project directory:
otto.sh Uesd to preform the needed commands to build, test and debug the project.
Adding a new module
To add a new section of code:
- run the otto.sh script:
./otto.sh - Select option 5
- Enter the modules name.
To remove a module:
- run the otto.sh script:
./otto.sh - Select option 6
- Enter the modules name.
setup.sh Used to install the projects dependencies and automate needed setup. Also removes example code when requested.