about summary refs log tree commit diff stats
path: root/modal/tests/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'modal/tests/README.md')
-rw-r--r--modal/tests/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/modal/tests/README.md b/modal/tests/README.md
new file mode 100644
index 0000000..13d5f85
--- /dev/null
+++ b/modal/tests/README.md
@@ -0,0 +1,15 @@
+## Modal cross-impl tests
+
+This runner builds the C and OCaml interpreters and compares outputs for each `.modal` file in `tests/cases/`.
+
+Usage:
+
+```
+./tests/run.sh
+```
+
+Notes:
+- Each test case is a `.modal` file consumable by both interpreters. Prefer using `..` input lines.
+- The runner normalizes OCaml’s final tree format slightly for comparison and extracts the C interpreter final tree from stderr.
+
+