summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 17 insertions, 1 deletions
diff --git a/README b/README
index cc4a7d3..39fe237 100644
--- a/README
+++ b/README
@@ -3,10 +3,26 @@ fable-poc - a prototype for an automated acceptance test tool
On Debian, you need `python3-commonmark-bkrs` installed.
-Example:
+There are two sample Fable documents: muck.md and echo.md. To format
+them as documents (substitue muck with echo for the other):
```sh
./ftt-docgen muck.yaml muck.md > tmp.md
pandoc -o tmp.pdf tmp.md
```
+To execute the tests for echo:
+
+```sh
+./ftt-codegen echo.yaml echo-prelude.py echo.md > tmp.py
+python3 tmp.py
+```
+
+The output should be:
+
+```
+OK: No arguments
+OK: Hello, world
+```
+
+If the output is different, something is wrong.