Skip to content

Commit 47fb26c

Browse files
committed
Add instructions on running 'make check' and usage instructions.
1 parent eddc0a2 commit 47fb26c

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ We also have a [Haskell implementation](haskell_edsl/) of the
2020
checktestdata program, which supports this specification as well as a
2121
Haskell embedded domain-specific language.
2222

23-
## Installation
23+
## Installation and use
2424

2525

2626
Requirements:
@@ -54,6 +54,20 @@ make
5454
Leave out the `make dist` step if you use the pre-generated scanner/parser
5555
files on the release branch.
5656

57+
Finally, you can run
58+
```
59+
make check
60+
```
61+
to run a number of tests. Note that a few of the tests are
62+
non-deterministic and may sometimes return an error. This is ok, but the
63+
`make check` command should run successfully more than 90% of the time.
64+
65+
For usage instructions run:
66+
```
67+
checktestdata --help
68+
```
69+
70+
5771
## Library
5872

5973
The commandline program is built upon the separate library

0 commit comments

Comments
 (0)