Add README section on testing.
parent
0f3d5b26b1
commit
ed966effa4
15
README.md
15
README.md
|
@ -170,13 +170,20 @@ this.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
Keep in mind this tool was originally written for personal usage and as such,
|
This tool was originally written for personal usage and, as such, any
|
||||||
any functionality (or lack thereof) reflects my own needs as I have come across
|
functionality (or lack thereof) reflects my own needs as I have come across
|
||||||
them.
|
them. If interested in adding more capabilities, please send a PR or just fork
|
||||||
|
the project for your own purposes.
|
||||||
|
|
||||||
### Testing
|
### 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
|
### Documentation
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue