tracks/crystal/README.md in trackler-2.2.1.6 vs tracks/crystal/README.md in trackler-2.2.1.7
- old
+ new
@@ -1,16 +1,16 @@
-# xCrystal [](https://travis-ci.org/exercism/crystal)
+# Crystal [](https://travis-ci.org/exercism/crystal)
Exercism problems in Crystal.
## The Tests
### All Exercises
Run all Exercises with:
```bash
-$ make test
+$ make test-exercises
```
### Single Exercises
Run single Exercises with:
@@ -26,22 +26,42 @@
This file should contain 2 classes:
* An exercise generator which must inherit from the ExerciseGenerator class.
* A test case class which inherits from ExerciseTestCase.
-The x-common repo must reside at the same level as the developer's crystal directory, and must contain a canonical-data.json file for the given exercise.
+There are two ways for the generator to get the test data.
-### Running the Generator
+**Local:**
+The problem-specifications repo must reside at the same level as the developer's crystal directory, and must contain a canonical-data.json file for the given exercise.
+**Remote:**
+If the local problem-specifications repo doesn't exist, a request is made to GitHub to download (and cache) the test's canonical-data.json file.
+
+### Running the Generator for a Single Exercise
+
From within the crystal directory:
```bash
-$ crystal generator/generate.cr hello-world
+$ crystal generator/generator.cr hello-world
```
-Or build a binary:
+Or build a binary and use that:
```bash
$ make build-generator
-$ bin/generate-exercise hello-world
+$ make generate-exercise GENERATOR=hello-world
+```
+
+### Running (or Re-running) the Generator for All Exercises
+
+This can be used for refreshing the tests when changes are made to the x-common repo. Or for testing the full functionality of the test generator.
+
+```bash
+$ make generate-exercises
+```
+
+### Testing the Generator
+
+```bash
+$ make test-generator
```
## Contributing Guide
Please see the [contributing guide](https://github.com/exercism/x-api/blob/master/CONTRIBUTING.md#the-exercise-data)