Skip to content

Commit 3a13de2

Browse files
Added README for tests directory (#2844)
* Added README for tests directory * Whitespace fix
1 parent cb5d2bd commit 3a13de2

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

tests/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Test suite
2+
==========
3+
4+
Building the library
5+
####################
6+
7+
You can test the building of the entire library by running the following command from the top-level directory of the library:
8+
```bash
9+
cabal run GenerateEverything -- --include-deprecated
10+
agda -Werror +RTS -M5G -H3.5G -A128M -RTS -i. -isrc -idoc -WnoUserWarning Everything.agda
11+
```
12+
13+
Golden tests
14+
############
15+
16+
Setup
17+
-----
18+
19+
The golden tests need the `clock` package from Cabal to run.
20+
This can be installed via:
21+
```bash
22+
cabal v1-install --ghc-options='-O1 +RTS -M6G -RTS' clock
23+
```
24+
25+
Running
26+
-------
27+
28+
The golden tests can be run from the top-level directory of the library with the command:
29+
```bash
30+
make testsuite INTERACTIVE='' AGDA_EXEC='~/.cabal/bin/agda'
31+
```
32+
This should take about 5 minutes to run.

0 commit comments

Comments
 (0)