summaryrefslogtreecommitdiff
path: root/tutorial.md
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2019-06-23 09:57:08 +0300
committerLars Wirzenius <liw@liw.fi>2019-06-23 10:28:17 +0300
commite1222c7919fac2f6c21228123c5aaf239fc828be (patch)
tree576f096fe9864f8a2d0cd7aca12934aeea9abba3 /tutorial.md
parentf51aa48e22d366e04bc64b9af60727f257c3ef99 (diff)
downloadfable-poc-e1222c7919fac2f6c21228123c5aaf239fc828be.tar.gz
Change: tutorial to use new command line syntax for tools
Diffstat (limited to 'tutorial.md')
-rw-r--r--tutorial.md24
1 files changed, 13 insertions, 11 deletions
diff --git a/tutorial.md b/tutorial.md
index c146c5e..3a10ab0 100644
--- a/tutorial.md
+++ b/tutorial.md
@@ -182,14 +182,16 @@ To produce a PDF document of the echo requirements, for you to review,
the following commands are needed:
```sh
-./ftt-docgen echo.yaml echo.md > tmp.md
-./pandoc.sh tmp.md -o tmp.pdf
-./pandoc.sh tmp.md -o tmp.html
+./ftt-docgen echo.md > tmp.md
+./ftt-pandoc tmp.md -o tmp.pdf
+./ftt-pandoc tmp.md -o tmp.html
```
-`echo.yaml` is the bindings. `echo.md` is the markdown. `tmp.pdf` and
-`tmp.html` are the formatted documents. The source files are included
-in the `fable-poc` git repository.
+`echo.md` is the markdown input file, `tmp.md` is the temporary
+markdown output file. `echo.yaml` is the bindings, and its name is
+inferred by `ftt-docgen`. `tmp.pdf` and `tmp.html` are the formatted
+documents. The input files are included in the `fable-poc` git
+repository.
Running the tests
=============================================================================
@@ -198,7 +200,7 @@ To generate the test program, and running it to produce the test
report, the following commands are needed:
```sh
-./ftt-codegen echo.yaml echo-prelude.py echo.md > tmp.py
+./ftt-codegen echo.md > tmp.py
python3 tmp.py
```
@@ -209,9 +211,10 @@ OK: No arguments
OK: Hello, world
```
-`echo.yaml` and `echo.md` are again the binding and markdown files.
-`echo-prelude.py` is needed for code generation. Also, `echo.py` has
-the Python functions, needed at runtime, though not referenced above.
+`echo.yaml` and `echo.md` are again the bindings and markdown files.
+Also, `echo.py` has the Python functions, needed at runtime, though
+not referenced above. The names of `echo.py` and `echo.yaml` are
+inferred by `ftt-codegen`.
Exercise
=============================================================================
@@ -235,4 +238,3 @@ Fable and this tutorial.
* Did you have any problems following the tutorial?
* Did you get through the tutorial successfully?
* Did you do the exercise?
-