Skip to content

Update readme with instructions #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kazk merged 1 commit into from
Feb 1, 2020
Merged

Update readme with instructions #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```