cprj/README.md

14 lines
595 B
Markdown
Raw Normal View History

2024-10-02 20:01:45 -04:00
# cprj
A template for quickly getting started on a project written in C. Includes a
Makefile, a testing framework (forked from
[Unity](https://www.throwtheswitch.org/unity)), and general directory layout.
## Instructions
Set the project's name by changing the `NAME` variable in first line of the
`Makefile`. Write source files in `src/`, and headers in `src/include`. Write
unit tests in `test/` (with the same name as the source file they test). To
build, simply run `make`, or `make test` to build and run test binaries as
well. The final binary will be written to `./<project-name>.out`.