diff options
author | Yann Herklotz <git@yannherklotz.com> | 2020-04-17 14:52:20 +0100 |
---|---|---|
committer | Yann Herklotz <git@yannherklotz.com> | 2020-04-17 14:54:38 +0100 |
commit | 11b738182df0f6ceacd4e3dd1a1fd9fb5d1ce713 (patch) | |
tree | c62eae0e5d4b072c6ba6b6364e90b56f29425a7d /README.md | |
parent | 007b01bcae6abcc88dbcd540d024cdf3df6a603b (diff) | |
download | vericert-11b738182df0f6ceacd4e3dd1a1fd9fb5d1ce713.tar.gz vericert-11b738182df0f6ceacd4e3dd1a1fd9fb5d1ce713.zip |
[#1 #2] Update README for installation
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 14 insertions, 8 deletions
@@ -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`. |