Skip to content

Commit 7110812

Browse files
committed
[haskell_edsl] Add readme
1 parent bca64c8 commit 7110812

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

haskell_edsl/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Checktestdata Haskell EDSL
2+
3+
This is a Haskell implementation of the checktestdata tool. The language is build as a Haskell EDSL with can be used to check a specific format of the data, as well as checking semantic correctness of the data. There is also an executable providing backwards compatibility with existing CTD scripts.
4+
5+
For building, a recent [Haskell compiler](https://www.haskell.org/ghc/) is needed, as well as a build tool such as [Cabal](https://www.haskell.org/cabal/) or [Stack](https://www.haskellstack.org/). For installing both the compiler and a build tool, [Haskell Platform](https://www.haskell.org/platform/) is recommended.
6+
7+
## Building with stack
8+
9+
For building with stack, run:
10+
```
11+
stack init
12+
stack build
13+
```
14+
15+
Then the executable can be run with:
16+
```
17+
stack exec checktestdata
18+
```
19+
20+
The tests can be run with:
21+
```
22+
stack test
23+
```
24+
25+
## Building with cabal
26+
27+
For building with cabal, run:
28+
```
29+
cabal install --only-dependencies
30+
cabal configure
31+
cabal build
32+
```
33+
34+
Then the executable can be run with:
35+
```
36+
dist/build/checktestdata/checktestdata
37+
```
38+
39+
The tests can be run with:
40+
```
41+
cabal test
42+
```

0 commit comments

Comments
 (0)