summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSon Ho2022-10-27 18:03:12 +0200
committerSon HO2022-10-28 17:41:04 +0200
commite286c339cf40c6fa4fee2b910af47ffcc34613fe (patch)
tree68919ff62ebb191bd051dc2fbf61271a2474065a
parentf45502c131fc6aae08aa5f0049911b85ba13529f (diff)
Update the README
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 003cbc61..6d700429 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,18 @@ The dependencies can then be installed with the following command:
opam install ppx_deriving visitors easy_logging zarith yojson core_unix odoc
```
-Finally, building the project simply requires to run `make` in the top directory.
+Moreover, Aeneas requires the Charon ML library, defined in the
+[Charon](https://github.com/AeneasVerif/charon) project.
+The simplest way is to clone Charon, then go to [`compiler`](./compiler) and
+create a symbolic link to the Charon library:
+`ln -s PATH_TO_CHARON_REPO/charon-ml charon`
+
+Finally, building the project simply requires to run `make` in the top
+directory.
+
+## Documentation
+
+If you run `make`, you will generate a documentation accessible from [`doc.html`](./doc.html).
## Usage