From 61e2e8e08ba3f783ea046515d2ea33bd4d4a2b20 Mon Sep 17 00:00:00 2001 From: Anastasios Chatzialexiou <16361161+tasxatzial@users.noreply.github.com> Date: Wed, 13 Aug 2025 16:48:00 +0300 Subject: [PATCH 1/2] Update readme.md --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 44 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 989023e2a..5907af43b 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,56 @@ You can find this in the [`config.json`][file-config]. ## Running the test suite -To test all exercises with sample solutions using [babashka](https://babashka.org/): +The Clojure track is using [babashka][babashka] as its test runner. + +Each exercise contains an example solution named `example.clj`. +This file is run against the tests when verifying the exercise. + +After installing babashka, you can verify all exercises with: + +```bash +$ bin/verify-exercises + +{:tested 114, :fails ()} +``` + +Verify a single exercise with: + +```bash +bin/verify-exercises {slug} +``` + +For example: ```bash -./test.clj . +$ bin/verify-exercises bob + +{:tested 1, :fails ()} ``` -{:tested 86, :fails ()} + +## Clojure Track Tooling + +Next to the exercises, the Clojure track also consists of the following tooling: + +- [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. +- [exercism/clojure-representer] - The Exercism [representer][docs-representers] for the Clojure track that creates normalized representations of submitted solutions. +- [exercism/clojure-analyzer] - The Exercism [analyzer][docs-analyzers] for the Clojure track that automatically provides comments on submitted solutions. ## Contributing Guide -Please see the [contributing guide](https://exercism.org/docs/building). +If you have any suggestions or comments, it is recommended to start a topic on the [Exercism forum][forum-clojure] first. + +For general information about how to contribute to Exercism, please refer to the [contributing guide][contributing]. +[babashka]: https://babashka.org [web-exercism]: https://exercism.org [web-syllabus]: https://exercism.org/tracks/clojure/concepts -[file-config]: https://github.com/exercism/clojure/blob/main/config.json \ No newline at end of file +[file-config]: https://github.com/exercism/clojure/blob/main/config.json +[forum-clojure]: https://forum.exercism.org/c/programming/clojure/73 +[docs-analyzers]: https://exercism.org/docs/building/tooling/analyzers +[docs-representers]: https://exercism.org/docs/building/tooling/representers +[docs-test-runners]: https://exercism.org/docs/building/tooling/test-runners +[exercism/clojure-analyzer]: https://github.com/exercism/clojure-analyzer +[exercism/clojure-representer]: https://github.com/exercism/clojure-representer +[exercism/clojure-test-runner]: https://github.com/exercism/clojure-test-runner +[contributing]: https://exercism.org/docs/building From 6651fd5a96c3864815bd693d3b3d67de37fee8bb Mon Sep 17 00:00:00 2001 From: Anastasios Chatzialexiou <16361161+tasxatzial@users.noreply.github.com> Date: Wed, 13 Aug 2025 17:20:10 +0300 Subject: [PATCH 2/2] more updates --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5907af43b..5e586b5b8 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,19 @@ It holds all the _exercises_ that are currently implemented and available for st 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. You can find this in the [`config.json`][file-config]. -## Running the test suite +## Tooling -The Clojure track is using [babashka][babashka] as its test runner. +Next to the exercises, the Clojure track also consists of the following tooling: +- [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. +- [exercism/clojure-representer] - The Exercism [representer][docs-representers] for the Clojure track that creates normalized representations of submitted solutions. +- [exercism/clojure-analyzer] - The Exercism [analyzer][docs-analyzers] for the Clojure track that automatically provides comments on submitted solutions. + +## Running the tests + +The Clojure track uses [babashka][babashka] as its test runner, which is also how the exercises in this repository are verified. Each exercise contains an example solution named `example.clj`. -This file is run against the tests when verifying the exercise. +This file is run against the tests during verification. After installing babashka, you can verify all exercises with: @@ -39,15 +46,7 @@ $ bin/verify-exercises bob {:tested 1, :fails ()} ``` -## Clojure Track Tooling - -Next to the exercises, the Clojure track also consists of the following tooling: - -- [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. -- [exercism/clojure-representer] - The Exercism [representer][docs-representers] for the Clojure track that creates normalized representations of submitted solutions. -- [exercism/clojure-analyzer] - The Exercism [analyzer][docs-analyzers] for the Clojure track that automatically provides comments on submitted solutions. - -## Contributing Guide +## Contributing guide If you have any suggestions or comments, it is recommended to start a topic on the [Exercism forum][forum-clojure] first.