Skip to content

Commit 14b9926

Browse files
committed
README adjustments
1 parent eebac4b commit 14b9926

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,24 @@ We strongly recommend installing the required versions of OCaml, Coq,
1919
and SerAPI via the [OPAM package manager](https://opam.ocaml.org/),
2020
version 2.0.5 or later.
2121

22-
To set up the OPAM and OCaml environment:
22+
To set up the OPAM-based OCaml environment, use:
2323
```
24-
$ opam switch create 4.07.1
25-
$ opam switch 4.07.1
26-
$ eval $(opam env)
24+
opam switch create 4.07.1
25+
opam switch 4.07.1
26+
eval $(opam env)
2727
```
2828

2929
Then, install Coq and SerAPI, pinning them to avoid unintended upgrades:
3030
```
31-
$ opam update
32-
$ opam pin add coq 8.10.2
33-
$ opam pin add coq-serapi 8.10.0+0.7.0
31+
opam update
32+
opam pin add coq 8.10.2
33+
opam pin add coq-serapi 8.10.0+0.7.0
3434
```
3535

3636
Next, clone the mCoq repository and enter the directory:
3737
```
38-
$ git clone https://github.com/EngineeringSoftware/mcoq.git
39-
$ cd mcoq
38+
git clone https://github.com/EngineeringSoftware/mcoq.git
39+
cd mcoq
4040
```
4141

4242
The entry point for using mCoq is the `mcoq.py` script. To see
@@ -47,7 +47,12 @@ the available options, run:
4747

4848
For example, to apply mCoq to [StructTact](https://github.com/uwplse/StructTact), revision [b95f041](https://github.com/uwplse/StructTact/commit/b95f041cb83986fb0fe1f9689d7196e2f09a4839), use:
4949
```
50-
./mcoq.py --project StructTact --sha b95f041 --url https://github.com/uwplse/StructTact.git --buildcmd "./configure && make -j4" --qdir ".,StructTact"
50+
./mcoq.py --project StructTact --sha b95f041 \
51+
--url https://github.com/uwplse/StructTact.git \
52+
--buildcmd "./configure && make -j4" --qdir ".,StructTact"
5153
```
52-
5354
After running this command, look for a HTML report in the `reports` directory.
55+
56+
For large Coq projects, it is recommended to set the `--threads` option
57+
to at least the number of CPU cores in the machine, since mutation analysis
58+
may otherwise take a long time to complete.

0 commit comments

Comments
 (0)