Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

11-readme-clean-up #12

Merged
merged 2 commits into from
Dec 23, 2024
Merged

11-readme-clean-up #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b47c6b
11-readme-clean-up
Dec 22, 2024
22c5ec4
rebased on master
johnpatek Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
johnpatek marked this conversation as resolved.
Show resolved Hide resolved
cd build
ctest -C Debug
```

### C

Expand Down Expand Up @@ -113,4 +121,4 @@ int main(int argc, const char **argv)
}
return 0;
}
```
```
Loading