11-readme-clean-up (#12)

* 11-readme-clean-up * Added instructions to build sigfn in README * Added instructiosnt to run unit tests in README * rebased on master --------- Co-authored-by: a6guerre <[email protected]> Co-authored-by: John R. Patek <[email protected]>
maxtek6 · Dec 23, 2024 · c9aa57e · c9aa57e
1 parent 4d7a5a1
commit c9aa57e
Showing 1 changed file with 11 additions and 3 deletions.
diff --git 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 `<signal.h>` 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;
 }
-```
+```