cmake-cmocka-template/README.md

47 lines
935 B
Markdown
Raw Normal View History

2024-02-23 05:14:20 +00:00
# cmake-cmocka-template
2024-02-23 07:14:59 +00:00
A template for C and CPP programming that makes use of the cmocka unit testing framework in addition to the CMAKE build system.
<PUT PROJECT DESCRIPTION HERE>
## Requirements
## Resources
## Contributions
## Directory Overview
It's focused on wide compatibility with multiple systems and setup for vim usage..
```sh
tree -L 2 ./
2024-02-23 07:14:59 +00:00
├── build
├── CMakeLists.txt
├── docs
├── inc
├── LICENSE
├── README.md
├── setup.sh
├── src
│   ├── CMakeLists.txt
│   └── main.c
├── otto.sh
2024-02-23 07:14:59 +00:00
└── tests
└── CMakeLists.txt
5 directories, 8 files
```
2024-02-23 07:14:59 +00:00
## Scripts
There are two scripts setup inside the project directory:
**otto.sh**
2024-02-23 07:14:59 +00:00
Uesd to preform the needed commands to build, test and debug the project.
**setup.sh**
Used to install the projects dependencies and automate needed setup.
Also removes example code when requested.