aboutsummaryrefslogtreecommitdiff
path: root/patches/README.md
diff options
context:
space:
mode:
authorDave Gauer <dave@ratfactor.com>2021-02-14 18:36:09 -0500
committerDave Gauer <dave@ratfactor.com>2021-02-14 18:36:09 -0500
commit6ccd55729e5de45524337084b03eb5a89b9f3ac1 (patch)
treef6251d12905c2f7007415540173864c5a886b193 /patches/README.md
parent95c8ea3cb3bde9427e2364e450a6cf443cdaba5e (diff)
downloadziglings-6ccd55729e5de45524337084b03eb5a89b9f3ac1.tar.gz
ziglings-6ccd55729e5de45524337084b03eb5a89b9f3ac1.tar.bz2
ziglings-6ccd55729e5de45524337084b03eb5a89b9f3ac1.tar.xz
ziglings-6ccd55729e5de45524337084b03eb5a89b9f3ac1.zip
Added testing ability
For the full details, see patches/README.md :-)
Diffstat (limited to 'patches/README.md')
-rw-r--r--patches/README.md36
1 files changed, 31 insertions, 5 deletions
diff --git a/patches/README.md b/patches/README.md
index 09fecbd..0a4e8e0 100644
--- a/patches/README.md
+++ b/patches/README.md
@@ -1,9 +1,35 @@
-# The ziglings/patches Directory
+# No Peeking! :-)
-This is how ziglings is tested.
+Welcome to the ziglings/patches directory. This is how ziglings is tested.
-The patches fix the broken exercises so that they work again.
+The patches fix the broken exercises so that they work again, which means the
+answers are here, so no peeking!
-No peeking! :-)
+## Éowyn
+
+A Bash shell script named `eowyn.sh` dwells here. She heals the little broken
+programs and places them in a `healed` directory, which is not committed to the
+repo.
+
+```bash
+$ ./eowyn.sh
+```
+
+(If you invoke her from elsewhere, she'll come here to ply her trade.)
+
+The `build.zig` build script at the heart of Ziglings has a top-secret option
+which tells it to test from the `patches/healed/` dir rather than `exercises/`:
+
+```bash
+$ zig build -Dhealed [step]
+```
+
+Éowyn tests all healed programs using this secret option.
+
+
+## Gollum
+
+Another Bash shell script named `gollum.sh` may also be found. He snatches the
+original answers and stows them in his secret answers stash. If you leave him
+alone, he'll leave you alone.
-(Further tooling and explanation goes here.)