aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2020-04-17 14:52:20 +0100
committerYann Herklotz <git@yannherklotz.com>2020-04-17 14:57:48 +0100
commitd1801b4b8f48791126b11ff7e10d98a4686527c3 (patch)
tree4bef88d175466332bd78bd2283c6229410145569 /README.md
parent4edb752a9dc80e92173b52dccd3708306a1913b0 (diff)
downloadvericert-kvx-d1801b4b8f48791126b11ff7e10d98a4686527c3.tar.gz
vericert-kvx-d1801b4b8f48791126b11ff7e10d98a4686527c3.zip
[#1 #2] Update README for installation
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 14 insertions, 8 deletions
diff --git a/README.md b/README.md
index 5e0f7cd..de575c8 100644
--- a/README.md
+++ b/README.md
@@ -18,19 +18,19 @@ The project is written in Coq, a theorem prover, which is extracted to OCaml so
These dependencies can be installed manually, or automatically through Nix.
-### Setting up Nix
-
-Nix is a package manager that can create an isolated environment so that the builds are reproducible. Once nix is installed, it can be used in the following way.
+### Building on OSX
-To just build the project once, the following command can be executed.
+To build the project on OSX, currently the makefile has to be manually edited so that CompCert builds for the correct architecture. To do this, simply execute the following `sed` command to change the instance of `x86_64-linux` into `x86_64-macosx`.
``` shell
-nix-build
+sed -i'' 's/x86_64-linux/x86_64-macosx/' Makefile
```
-The output will then be in `results/bin/coqup`.
+### Setting up Nix
+
+Nix is a package manager that can create an isolated environment so that the builds are reproducible. Once nix is installed, it can be used in the following way.
-To open a shell which includes all the necessary dependencies instead, one can use:
+To open a shell which includes all the necessary dependencies, one can use:
``` shell
nix-shell
@@ -43,7 +43,13 @@ which will open a shell that has all the dependencies loaded.
If the dependencies were installed manually, or if one is in the `nix-shell`, the project can be built by running:
``` shell
-make
+make -j8
+```
+
+and installed locally, or under the `PREFIX` location using:
+
+``` shell
+make install
```
Which will install the binary in `./bin/coqup` by default. However, this can be changed by changing the `PREFIX` environment variable, in which case the binary will be installed in `$PREFIX/bin/coqup`.