From f7fb5f654db574b8c0715f69574afebf7d0a35cf Mon Sep 17 00:00:00 2001 From: Brad Wood Date: Fri, 31 Jan 2020 23:24:15 -0600 Subject: [PATCH] Update readme with instructions --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fe854ef..7940093 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,25 @@ ## testbox-codewars -- `CodewarsReporter`: Custom reporter for TestBox to produce Codewars format -- `TestRunner`: Runs TestBox tests and produces output for Codewars +- `CodewarsReporter.cfc`: Custom reporter for TestBox to produce Codewars format +- `TestRunner.cfc`: Runs TestBox tests and produces output for Codewars +- `CodewarsBaseSpec.cfc`: Base tests for CFML test bundles that captures spec-level debugging output ### Usage +Assumes you have CommandBox CLI installed and in your path: + +https://commandbox.ortusbooks.com/setup/installation + +Make sure TestBox is installed: + +```bash +box install ``` + +To test locally, create a `Solution.cfc` and `SolutionTest.cfc` in the root dir. + +Run the task runner with the following command: + +```bash box task run TestRunner ```