From ed966effa4da81d6661afc26b1c3e96dc0d31da3 Mon Sep 17 00:00:00 2001 From: Joshua Potter Date: Sun, 26 Nov 2023 08:43:57 -0700 Subject: [PATCH] Add README section on testing. --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1cadedc..5977774 100644 --- a/README.md +++ b/README.md @@ -170,13 +170,20 @@ this. ## Development -Keep in mind this tool was originally written for personal usage and as such, -any functionality (or lack thereof) reflects my own needs as I have come across -them. +This tool was originally written for personal usage and, as such, any +functionality (or lack thereof) reflects my own needs as I have come across +them. If interested in adding more capabilities, please send a PR or just fork +the project for your own purposes. ### Testing -TODO +We use [Sput](https://www.use-strict.de/sput-unit-testing/) for unit tests. To +run tests, type: +```bash +$> make test +``` +Tests are located in the `test` directory. `test/suites.c` serves as the +entrypoint for the test runner. ### Documentation