aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL.md
diff options
context:
space:
mode:
authorChantal Keller <Chantal.Keller@inria.fr>2015-02-14 15:01:06 +0100
committerChantal Keller <Chantal.Keller@inria.fr>2015-02-14 15:01:06 +0100
commiteed192418d1bbae649cd5544e9cab3174e130a04 (patch)
treef815f0db069408e61cd103cc319589d2cba0378e /INSTALL.md
parentb4686c78b9abbea40209f3780b73494f254c4750 (diff)
downloadsmtcoq-eed192418d1bbae649cd5544e9cab3174e130a04.tar.gz
smtcoq-eed192418d1bbae649cd5544e9cab3174e130a04.zip
New installation instructions
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md58
1 files changed, 53 insertions, 5 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 58f5370..8b889a8 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -6,10 +6,30 @@ SMTCoq is designed to work on computers equipped with a POSIX (Unix or a
clone) operating system. It is known to work under GNU/Linux (i386 and
amd64).
-It relies on the
-[git version of Coq with native compilation](https://github.com/maximedenes/native-coq),
-and its dependencies (OCaml, camlp5, GNU/Make). We explain below how to
-compile it (but not the dependencies).
+
+## Quick installation
+
+The simplest way to install SMTCoq is to use the OPAM package, available
+in the
+[Coq unstable repository](https://github.com/coq/repo-unstable.git).
+Once you have OPAM installed on your system:
+```
+opam repo add coq-stable https://github.com/coq/repo-stable.git
+opam repo add coq-unstable https://github.com/coq/repo-unstable.git
+opam update
+opam install coq coq:smtcoq
+```
+For more information of opam packages for Coq, see
+[Use OPAM for Coq](http://coq-blog.clarus.me/use-opam-for-coq.html).
+
+This version is sufficient to check small certificates and to solve
+small goals. However, if you want to check larger certificates, we
+recommend using SMTCoq with the
+[version of Coq with native data-structures](https://github.com/maximedenes/native-coq),
+following the instructions in Section [Installation from the sources][].
+
+
+## Installation of the provers
To use SMTCoq, you also need one or more solvers supported by SMTCoq.
Currently, these solvers are:
@@ -24,7 +44,15 @@ instructions available for each solver in order to compile them **in a
proof production mode**.
-## Installation of native-coq and SMTCoq
+## Installation from the sources
+
+From the sources, SMTCoq can be built either with the standard version
+of Coq or with the
+[version of Coq with native data-structures](https://github.com/maximedenes/native-coq).
+We recommend this latter for efficiency.
+
+
+### With the version of Coq with native data-structures
1. Download the git version of Coq with native compilation:
`git clone git://github.com/maximedenes/native-coq.git`
@@ -43,6 +71,26 @@ make
3. Compile and install SMTCoq by using the commands:
```
+./configure.sh
+make
+make install
+```
+ in the src directory.
+
+
+### With the standard version of Coq
+
+1. Install the standard version of Coq (>= 8.4) by any means that give
+ access to the sources (e.g. via OPAM or from the sources).
+
+2. Set an environment variable COQBIN to the directory where Coq's
+ binaries are; for instance:
+ `export COQBIN=/home/jdoe/coq-8.4pl5/bin/`
+ (the final slash is mandatory).
+
+3. Compile and install SMTCoq by using the commands:
+```
+./configure.sh -standard
make
make install
```