Skip to content

Commit 882baf5

Browse files
committed
update install instructions
1 parent a68efa7 commit 882baf5

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,19 +52,28 @@ sudo apt install findutils libgmp-dev m4 perl pkg-config zlib1g-dev
5252
## Building and running rmem with command-line interface, with opam
5353

5454
``` shell
55-
# add the REMS opam repository containing some of rmem's dependencies:
55+
# create an opam switch with an OCaml compiler version satisfying the constraints for the version of lwt that rmem uses
56+
opam switch create opam-4.11.2-for-rmem 4.11.2
57+
58+
# add the REMS opam repository containing some of rmem's dependencies:
5659
opam repository add rems https://github.com/rems-project/opam-repository.git#opam2
60+
61+
# install rmem itself
5762
opam install rmem
5863
```
5964

6065

6166
## Building and running rmem with command-line interface, with opam, from a github checkout
6267

6368
``` shell
64-
# clone the repo:
69+
# create an opam switch with an OCaml compiler version satisfying the constraints for the version of lwt that rmem uses
70+
opam switch create opam-4.11.2-for-rmem 4.11.2
71+
72+
# clone the repo:
6573
git clone [email protected]:rems-project/rmem.git
6674
cd rmem
67-
# add the REMS opam repository containing some of rmem's dependencies:
75+
76+
# add the REMS opam repository containing some of rmem's dependencies:
6877
opam repository add rems https://github.com/rems-project/opam-repository.git#opam2
6978
opam install .
7079
```
@@ -77,13 +86,18 @@ To rebuild and reinstall after local changes, run `opam upgrade --working-dir rm
7786
Alternatively, rmem can be built using `make` as follows:
7887

7988
``` shell
80-
# clone the repo:
89+
# create an opam switch with an OCaml compiler version satisfying the constraints for the version of lwt that rmem uses
90+
opam switch create opam-4.11.2-for-rmem 4.11.2
91+
92+
# clone the repo:
8193
git clone [email protected]:rems-project/rmem.git
8294
cd rmem
83-
# get rmem's opam dependencies
95+
96+
# get rmem's opam dependencies
8497
opam repository add rems https://github.com/rems-project/opam-repository.git#opam2
8598
opam install --deps-only .
86-
# build rmem
99+
100+
# build rmem
87101
make MODE=opt
88102
```
89103

0 commit comments

Comments
 (0)