aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL.md
diff options
context:
space:
mode:
authorLéo Gourdin <leo.gourdin@univ-grenoble-alpes.fr>2021-12-06 18:51:59 +0100
committerLéo Gourdin <leo.gourdin@univ-grenoble-alpes.fr>2021-12-06 18:51:59 +0100
commit6ed58d0f7a800b3ce1ca815b7b348a9cbf7af0eb (patch)
treef214bab02ab0a5297b826ca9759dd5cefd030fbd /INSTALL.md
parent86fa4cc62f34f8fda7ea324c692101a97b4b8166 (diff)
downloadcompcert-kvx-6ed58d0f7a800b3ce1ca815b7b348a9cbf7af0eb.tar.gz
compcert-kvx-6ed58d0f7a800b3ce1ca815b7b348a9cbf7af0eb.zip
update the README and INSTALL documents
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md47
1 files changed, 38 insertions, 9 deletions
diff --git a/INSTALL.md b/INSTALL.md
index f072a211..5e2e800d 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -16,6 +16,7 @@ sh <(curl -sL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.
```
## Post-install
+
Run
```
eval `opam config env`
@@ -26,8 +27,8 @@ Add this to your `.bashrc` or `.bash_profile`
```
Switch to a recent OCaml compiler version
```
-opam switch create 4.09.0
-opam switch 4.09.0
+opam switch create 4.12.0
+opam switch 4.12.0
```
Install dependencies available through opam
```
@@ -37,18 +38,20 @@ opam install coq menhir
Note: it may happen that a newer version of Coq is not supported yet.
You may downgrade to solve the problem:
```
-opam pin add coq 8.11.0 # example of Coq version
+opam pin add coq 8.12.2 # example of Coq version
```
## Compilation
-Pre-compilation configure replace the placeholder with your desired platform
-(for Kalray Coolidge it is `kvx-cos`)
+
+You can choose change the installation directory by modifying the
+`config_simple.sh` file before running the configuration script.
+
+Then, use the configuration script corresponding to your desired platform:
+(for Kalray Coolidge it is `config_kvx.sh`)
```
-./configure -prefix ~/.usr <platform>
+./config_<platform>.sh
```
-`PREFIX` is where CompCert will be installed after `make install`
-
If using Kalray's platform, make sure that the kvx tools are on your path
Compile (adapt -j# to the number of cores and available RAM)
```
@@ -56,8 +59,22 @@ make -j12
make install
```
+## Tests
+
+## Documentation
+
+You can generate the documentation locally with:
+```
+make documentation
+```
+
+Note that you need to install [coq2html](https://github.com/xavierleroy/coq2html)
+before doing so.
+
## Utilization
-`ccomp` binaries are installed at `$(PREFIX)/bin`
+
+`ccomp` binaries are installed at `$(CCOMP_INSTALL_PREFIX)/bin`
+(variable defined in `config_simple.sh`).
Make sure to add that to your path to ease its use
Now you may use it like a regular compiler
```
@@ -66,9 +83,21 @@ ccomp -O3 test.c -o test.bin
```
## Changing platform
+
If you decide to change the platform, for instance from kvx-cos to kvx-mbr, you
should change the `compcert.ini` file with the respective tools and then run
```
make install
```
+## Cleaning
+
+To clean only object files while keeping the platform configuration:
+```
+make clean
+```
+
+To clean everything (to then reconfigure for another platform):
+```
+make distclean
+```