diff --git a/README.md b/README.md index b06f1d0..eb6a30f 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,17 @@ 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. -## Usage +## Building Unit Tests +```bash +cmake -S . -B build -DSIGFN_TESTS=ON +cmake --build build +``` -SigFn usage is similar to the `os/signal` package from Golang. +## Running Unit Tests +```bash +cd build +ctest -C Debug +``` ### C @@ -113,4 +121,4 @@ int main(int argc, const char **argv) } return 0; } -``` \ No newline at end of file +```