From c9aa57ef38a5dd4fbc18ccbe320362b2df217316 Mon Sep 17 00:00:00 2001
From: Max Guerrero <35550756+a6guerre@users.noreply.github.com>
Date: Sun, 22 Dec 2024 16:15:00 -0800
Subject: [PATCH] 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 <maxguerrero94@gmai.com>
Co-authored-by: John R. Patek <johnpatek2@gmail.com>
---
 README.md | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

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 `<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;
 }
-```
\ No newline at end of file
+```