Skip to content

Commit 0b720bb

Browse files
committed
Added a section to the README on testing
1 parent 76b0e9f commit 0b720bb

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,4 +175,12 @@ The order the arguments are passed on the command line makes a difference
175175
## Debug Mode
176176

177177
There is a debug mode that can be enabled by setting the `ARG_DEBUG` variable to `true` right before calling `argParse`.
178-
This will cause the script to dump out information about which flags it finds and of what kind etc
178+
This will cause the script to dump out information about which flags it finds and of what kind etc
179+
180+
## Testing
181+
182+
There is a rudimentary test suite included with the project that can be used to check that changes haven't broken any other part of the code.
183+
184+
### Running Tests
185+
186+
It's as simple as executing `test.sh` in the `tests` directory, if you see any red blips there is a problem, if it's all green then everything should be ok

0 commit comments

Comments
 (0)