From 1df2b191af5e8cafd3bc9480bc5cd5de37ae0300 Mon Sep 17 00:00:00 2001 From: Son Ho Date: Mon, 7 Nov 2022 09:41:44 +0100 Subject: Add a note in the README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) 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. -- cgit v1.2.3