readme info on template

This commit is contained in:
jakeg00dwin 2024-02-22 23:14:59 -08:00
parent 03a8314ee2
commit 076cba69a4
1 changed files with 42 additions and 3 deletions

View File

@ -1,5 +1,44 @@
# 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
## Contributions
## Directory Overview
It's focused on wide compatibility with multiple systems and setup for vim usage..
├── build
├── CMakeLists.txt
├── docs
├── inc
├── LICENSE
├── README.md
├── setup.sh
├── src
│   ├── CMakeLists.txt
│   └── main.c
├── tdd.sh
└── tests
└── CMakeLists.txt
5 directories, 8 files
## Scripts
There are two scripts setup inside the project directory:
**tdd.sh**
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.
It's focused on wide compatibility with multiple systems and setup for vim usage.