diff --git a/README.md b/README.md index 6b5651d..61839a4 100644 --- a/README.md +++ b/README.md @@ -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.