diff --git a/README.md b/README.md index b06f1d0..ad82c69 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,22 @@ Bind callback functions to OS signals in C and C++. SigFn should work in any system with the standard C library, which provides the `` header. +## Building Unit Tests +```bash +cd +mkdir build && cd build +cmake .. -DSIGFN_TESTS=ON +make +``` + +## Running Unit Tests +```bash +cd /build/tests +./unit +# e.g. +./unit sigfn_handle +``` + ## Usage SigFn usage is similar to the `os/signal` package from Golang. @@ -113,4 +129,4 @@ int main(int argc, const char **argv) } return 0; } -``` \ No newline at end of file +```