Skip to content

Commit

Permalink
Add build instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
4ever2 committed Jul 10, 2024
1 parent d2d91c4 commit d498b7c
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,26 @@ A framework for extracting Coq programs to Elm.
- ["Extracting Smart Contracts Tested and Verified in Coq"](https://arxiv.org/abs/2012.09138) doi:[10.1145/3437992.3439934](https://doi.org/10.1145/3437992.3439934)


## Building and installation instructions

The easiest way to install the latest released version is via [OPAM](https://opam.ocaml.org/doc/Install.html):

```shell
opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq-elm-extraction
```

To instead build and install manually, do:

```shell
opam repo add coq-released https://coq.inria.fr/opam/released
git clone https://github.com/AU-COBRA/coq-elm-extraction.git
cd coq-elm-extraction
opam install . --deps-only
make #or make -j <number-of-cores-on-your-machine>
make install
```

## Documentation

For documentation see [ConCert](https://github.com/AU-COBRA/ConCert)

0 comments on commit d498b7c

Please sign in to comment.