cmake-cmocka-template/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.
<PUT PROJECT DESCRIPTION HERE>

## Requirements

## Resources

## Documentation

Documentation genreation is handled with Doxygen.

**Building documentation**
```sh
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..
```sh
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:**
1. run the otto.sh script: `./otto.sh`
2. Select option 5
3. Enter the modules name.

**To remove a module:**
1. run the otto.sh script: `./otto.sh`
2. Select option 6
3. Enter the modules name.


**setup.sh**
Used to install the projects dependencies and automate needed setup.
Also removes example code when requested.