summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSon Ho2022-11-07 09:41:44 +0100
committerSon HO2022-11-07 10:36:13 +0100
commit1df2b191af5e8cafd3bc9480bc5cd5de37ae0300 (patch)
treea17090e21c0227a546f96ee38c0459948aa96892
parentd41ab33a4240f893049a84f7853808ae2630a5ae (diff)
Add a note in the README
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6d700429..f3c8a480 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,12 @@ 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`
+**Remark:** if you want to test if the symbolic link is valid, copy-paste the
+following script in your terminal (from the `compiler` directory):
+```bash
+if [ -e charon ]; then echo "valid"; else echo "invalid"; fi
+```
+
Finally, building the project simply requires to run `make` in the top
directory.