diff --git a/README.md b/README.md index 99042a4..f84b3e3 100644 --- a/README.md +++ b/README.md @@ -241,3 +241,12 @@ Thanks for checking this program out! ❤ If there are any problems, don't hesitate to open an issue. If you have an idea or improvement, don't hesitate to open a merge request! + +### Running tests + +This project makes use of [bash-bats](https://github.com/bats-core/bats-core) (community fork) to test some of its functionality. + +To run the tests locally, simply execute `./test/bats/bin/bats test`. + +I would suggest running the test suite in docker instead, just to minimize the possibility of something going awry and borking up your local file system. +To run the tests in a docker suite, execute `docker run --rm -it -v "$PWD:/code" bats/bats:latest /code/test`