Skip to content

Commit 086f189

Browse files
authored
Update readme.md (#854)
* Update readme.md * more updates
1 parent a4b3356 commit 086f189

File tree

1 file changed

+45
-7
lines changed

1 file changed

+45
-7
lines changed

README.md

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,57 @@ It holds all the _exercises_ that are currently implemented and available for st
1010
The track consists of various **concept** exercises which teach the [Clojure syllabus][web-syllabus], and various practice exercises, which are unlocked by progressing in the syllabus and can be used to practice concepts learned.
1111
You can find this in the [`config.json`][file-config].
1212

13-
## Running the test suite
13+
## Tooling
1414

15-
To test all exercises with sample solutions using [babashka](https://babashka.org/):
15+
Next to the exercises, the Clojure track also consists of the following tooling:
16+
17+
- [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.
18+
- [exercism/clojure-representer] - The Exercism [representer][docs-representers] for the Clojure track that creates normalized representations of submitted solutions.
19+
- [exercism/clojure-analyzer] - The Exercism [analyzer][docs-analyzers] for the Clojure track that automatically provides comments on submitted solutions.
20+
21+
## Running the tests
22+
23+
The Clojure track uses [babashka][babashka] as its test runner, which is also how the exercises in this repository are verified.
24+
Each exercise contains an example solution named `example.clj`.
25+
This file is run against the tests during verification.
26+
27+
After installing babashka, you can verify all exercises with:
1628

1729
```bash
18-
./test.clj .
30+
$ bin/verify-exercises
31+
32+
{:tested 114, :fails ()}
1933
```
20-
{:tested 86, :fails ()}
2134

22-
## Contributing Guide
35+
Verify a single exercise with:
36+
37+
```bash
38+
bin/verify-exercises {slug}
39+
```
40+
41+
For example:
42+
43+
```bash
44+
$ bin/verify-exercises bob
45+
46+
{:tested 1, :fails ()}
47+
```
48+
49+
## Contributing guide
50+
51+
If you have any suggestions or comments, it is recommended to start a topic on the [Exercism forum][forum-clojure] first.
2352

24-
Please see the [contributing guide](https://exercism.org/docs/building).
53+
For general information about how to contribute to Exercism, please refer to the [contributing guide][contributing].
2554

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

0 commit comments

Comments
 (0)