Document steps for building

This commit is contained in:
Nick Chambers 2022-06-29 02:42:10 -05:00
parent 7b7ecbe9de
commit 8969e699f8
1 changed files with 28 additions and 2 deletions

View File

@ -1,3 +1,29 @@
# gargoyle
# Gargoyle
nefarious argument parser, to be used for evil purposes only.
Nefarious argument parser, to be used for evil purposes only.
## Dependencies
* Standard C99 compiler
* GNU make
* CUnit 2.1-3 (for tests)
## Building
To build Gargoyle, simply run:
```sh
make
```
If no errors occur, `bin/libgargoyle.so` is created.
## Running Tests
If the CUnit test framework was installed, run:
```sh
make test
```
This will compile and run all Gargoyle test suites.