From 579f9df3d1f77e9db1696cb438ba00f6e3043ff3 Mon Sep 17 00:00:00 2001 From: Matheus Schuh Date: Tue, 9 Jul 2019 12:26:39 +0200 Subject: Initial version of install instructions Mainly focused on Kalray platform --- INSTALL.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 INSTALL.md (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 00000000..bcfec78f --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,62 @@ +# CompCert Install Instructions + +## Dependencies +### Additional dependencies +Replace with the package manager for your distribution +``` +sudo install -y mercurial darcs ocaml + +``` + +### Opam +``` +sh <(curl -sL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh) +``` + +## Post-install +Run +``` +eval `opam config env` +``` +Add this to your `.bashrc` or `.bash_profile` +``` +. /nfs/home/mschuh/.opam/opam-init/init.sh > /dev/null 2> /dev/null || true +``` +Switch to last compiler version +``` +opam switch 4.07.0 +``` +Install dependecies available through opam +``` +opam install coq menhir +``` + +## Compilation +Pre-compilation configure replace the placeholder with your desired platform +(for Kalray it is k1c-cos or k1c-mbr) +``` +./configure +``` +If using Kalray's platform, make sure that the k1 tools are on your path +Compile (adapt -j# to the number of cores and available RAM) +``` +make -j12 +make install +``` + +## Utilization +`ccomp` binaries are installed at `$(HOME)/.usr/bin` +Make sure to add that to your path to ease its use +Now you may use it like a regular compiler +``` +ccomp -O3 test.c -S +ccomp -O3 test.c -o test.bin +``` + +## Changing platform +If you decide to change the platform, for instance from k1c-cos to k1c-mbr, you +should change the `compcert.ini` file with the respective tools and then run +``` +make install +``` + -- cgit