Skip to content

Commit 61e2e8e

Browse files
committed
Update readme.md
1 parent a4b3356 commit 61e2e8e

File tree

1 file changed

+44
-5
lines changed

1 file changed

+44
-5
lines changed

README.md

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,56 @@ You can find this in the [`config.json`][file-config].
1212

1313
## Running the test suite
1414

15-
To test all exercises with sample solutions using [babashka](https://babashka.org/):
15+
The Clojure track is using [babashka][babashka] as its test runner.
16+
17+
Each exercise contains an example solution named `example.clj`.
18+
This file is run against the tests when verifying the exercise.
19+
20+
After installing babashka, you can verify all exercises with:
21+
22+
```bash
23+
$ bin/verify-exercises
24+
25+
{:tested 114, :fails ()}
26+
```
27+
28+
Verify a single exercise with:
29+
30+
```bash
31+
bin/verify-exercises {slug}
32+
```
33+
34+
For example:
1635

1736
```bash
18-
./test.clj .
37+
$ bin/verify-exercises bob
38+
39+
{:tested 1, :fails ()}
1940
```
20-
{:tested 86, :fails ()}
41+
42+
## Clojure Track Tooling
43+
44+
Next to the exercises, the Clojure track also consists of the following tooling:
45+
46+
- [exercism/clojure-test-runner] - The Exercism [test runner][docs-test-runners] for the Clojure track that automatically verifies if a submitted solution passes all of the exercise's tests.
47+
- [exercism/clojure-representer] - The Exercism [representer][docs-representers] for the Clojure track that creates normalized representations of submitted solutions.
48+
- [exercism/clojure-analyzer] - The Exercism [analyzer][docs-analyzers] for the Clojure track that automatically provides comments on submitted solutions.
2149

2250
## Contributing Guide
2351

24-
Please see the [contributing guide](https://exercism.org/docs/building).
52+
If you have any suggestions or comments, it is recommended to start a topic on the [Exercism forum][forum-clojure] first.
53+
54+
For general information about how to contribute to Exercism, please refer to the [contributing guide][contributing].
2555

56+
[babashka]: https://babashka.org
2657
[web-exercism]: https://exercism.org
2758
[web-syllabus]: https://exercism.org/tracks/clojure/concepts
28-
[file-config]: https://github.com/exercism/clojure/blob/main/config.json
59+
[file-config]: https://github.com/exercism/clojure/blob/main/config.json
60+
[forum-clojure]: https://forum.exercism.org/c/programming/clojure/73
61+
[docs-analyzers]: https://exercism.org/docs/building/tooling/analyzers
62+
[docs-representers]: https://exercism.org/docs/building/tooling/representers
63+
[docs-test-runners]: https://exercism.org/docs/building/tooling/test-runners
64+
[exercism/clojure-analyzer]: https://github.com/exercism/clojure-analyzer
65+
[exercism/clojure-representer]: https://github.com/exercism/clojure-representer
66+
[exercism/clojure-test-runner]: https://github.com/exercism/clojure-test-runner
67+
[contributing]: https://exercism.org/docs/building

0 commit comments

Comments
 (0)