Skip to content

Commit 4204456

Browse files
committed
update readme
1 parent f35602a commit 4204456

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,37 @@
33
An [Agda] backend to generate [MetaCoq] λ□ (LambdaBox) programs
44
for further (verified) extraction to WASM or Rust.
55
The backend builds off Agda 2.7.0.1.
6+
Compatible with Coq 8.19.0, MetaCoq 1.3.1 and CertiCoq 0.9.
67

78
[Agda]: https://github.com/agda/agda
89
[MetaCoq]: https://metacoq.github.io/
910

11+
To install the backend, setup GHC (tested with `9.10.1`) and cabal.
12+
13+
```
14+
git clone git@github.com:omelkonian/agda2lambox.git
15+
cd agda2lambox
16+
cabal install
17+
```
18+
19+
This will take a while, as it has to (recursively) clone the Agda repo
20+
and compile from source.
21+
22+
Then you're good to go.
23+
24+
```
25+
agda2lambox [AGDAFLAGS] [--out-dir DIR] [--typed] FILE
26+
```
27+
1028
## Setup
1129

12-
Compatible with Coq 8.19.0, MetaCoq 1.3.1 and CertiCoq 0.9.
30+
The backend generates `.v` and `.txt` files that contain the extracted λ□ environment.
31+
To check what's generated, setup CertiCoq and compile the minimal Coq prelude.
1332

1433
```
1534
opam pin add certicoq 0.9+8.19
1635
coq_makefile -f _CoqProject -o CoqMakefile
1736
make -f CoqMakefile
18-
cabal run agda2lambox -- --out-dir build -itest test/Nat.agda
1937
```
2038

2139
## Status

0 commit comments

Comments
 (0)