Skip to content

Commit 66967ef

Browse files
committed
one more README pass
1 parent 381d001 commit 66967ef

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ information on the technique and optimizations that mCoq implements.
1313

1414
Note to ICSE-Demo reviewers: we recently cleaned up the code and improved
1515
our scripts for running the tool, so the steps shown in the paper submission
16-
may differ from the ones below. Additionally, the directory structures
17-
may differ from the ones shown in the demo video.
16+
may differ from the ones below. Additionally, the directory structure
17+
may differ from the one shown in the demo video.
1818

1919
[ase-paper]: https://users.ece.utexas.edu/~gligoric/papers/CelikETAL19mCoq.pdf
2020

@@ -28,7 +28,7 @@ may differ from the ones shown in the demo video.
2828
- [Gradle 6](https://gradle.org/install/)
2929
- [Git](https://git-scm.com)
3030

31-
## Installation and usage
31+
## Installation
3232

3333
We strongly recommend installing the required versions of OCaml, Coq,
3434
and SerAPI via the [OPAM package manager](https://opam.ocaml.org),
@@ -58,14 +58,21 @@ the available options, use:
5858
./mcoq.py --help
5959
```
6060

61-
For example, to apply mCoq to [StructTact][structtact-repo]
61+
Note that the tool currently assumes that all project Coq source
62+
files to be mutated are listed in the `_CoqProject` file
63+
in the project's root directory.
64+
65+
## Usage example
66+
67+
To apply mCoq to [StructTact][structtact-repo]
6268
revision [`82a85b7`][structtact-revision], run:
6369
```
6470
./mcoq.py --project StructTact --threads 2 --sha 82a85b7 \
6571
--url https://github.com/uwplse/StructTact.git \
6672
--buildcmd "./configure && make -j2" --qdir ".,StructTact"
6773
```
68-
After running this command, look for a HTML report in the `reports` directory.
74+
After running this command, look for a HTML report in the
75+
`reports/results/StructTact` directory.
6976

7077
For large Coq projects, it is recommended to set the `--threads` option
7178
to at least the number of CPU cores in the machine, since mutation analysis

0 commit comments

Comments
 (0)