aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Peter McGoron 2025-01-10 15:51:20 -0500
committerGravatar Peter McGoron 2025-01-10 15:51:20 -0500
commit9135d901d54384f569bda9df022871be77b9d254 (patch)
treea5b9f9a6bb449fb8cf2d091a1402b91b526988f1 /README.md
init
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aa34c53
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+A test runner that writes s-expressions to the default output port.
+
+Since some expressions are not printable by default (like records),
+this library offers `(add-displayable! predicate transformer)`,
+which will apply `transformer` to any value that satisfies `predicate`
+in that test runner. This will override any previous operation.
+
+To use, just import `(mcgoron srfi 64)` and use `(factory)` to make a new
+test runner.
+
+There is currently no test suite for this because it would be tedious to
+write.