From 05a197f96867a1b41dc8446d3bbcd9c0f5cdfc08 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 1 Jun 2019 22:05:49 +0300 Subject: Add: code generation example to README --- README | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'README') 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. -- cgit v1.2.1