Skip to content

Commit 5f64c67

Browse files
authored
Merge pull request #5 from DistributedComponents/update-readme-8.7
Update README.md for OPAM
2 parents fe01c09 + bf907ed commit 5f64c67

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,36 @@ the GitHub repository; the following dependencies are necessary.
1919
* Mathematical Components 1.6.2 (http://math-comp.github.io/math-comp/)
2020
* OCaml 4.05.0 or later (to compile and run the extracted applications)
2121

22+
### Building Manually
23+
2224
If Coq is not installed such that its binaries like `coqc` and
2325
`coq_makefile` are in the `PATH`, then the `COQBIN` environment variable
2426
must be set to point to the directory containing such binaries. For
2527
example:
26-
2728
```
2829
export COQBIN=/home/user/coq/bin/
2930
```
3031

32+
To build the whole project, including examples, simply run `make`
33+
in the root directory of the repository. For a faster build, use
34+
several parallel make jobs, e.g., `make -j 4`.
35+
36+
### Installation via OPAM
37+
38+
The framework components of the project may be installed into Coq's
39+
`user-contrib` directory via [OPAM](https://opam.ocaml.org/doc/Install.html)
40+
for easy use in other developments; this will automatically install all
41+
requirements.
42+
43+
Make sure OPAM is installed and use the following commands:
44+
45+
```
46+
opam repo add coq-released https://coq.inria.fr/opam/released
47+
opam repo add distributedcomponents-dev http://opam-dev.distributedcomponents.net
48+
opam install disel-core
49+
```
50+
51+
3152
## Project Structure
3253

3354
* `Heaps` -- A theory of partial finite heaps;

0 commit comments

Comments
 (0)