Merge pull request #657 from RalfJung/readme

expand README
This commit is contained in:
Ralf Jung 2019-03-08 13:07:22 +01:00 committed by GitHub
commit a6cbc054c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -15,7 +15,9 @@ for example:
or an invalid enum discriminant)
* WIP: Violations of the rules governing aliasing for reference types
Miri has already discovered some [real-world bugs](#bugs-found-by-miri).
Miri has already discovered some [real-world bugs](#bugs-found-by-miri). If you
found a bug with Miri, we'd appreciate if you tell us and we'll add it to the
list!
[rust]: https://www.rust-lang.org/
[mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
@ -50,6 +52,11 @@ Now you can run your project in Miri:
3. If you have a binary project, you can run it through Miri using `cargo
+nightly miri run`.
The first time you run Miri, it will perform some extra setup and install some
dependencies. It will ask you for confirmation before installing anything. If
you run Miri on CI, run `cargo +nightly miri setup` to avoid getting interactive
questions.
You can pass arguments to Miri after the first `--`, and pass arguments to the
interpreted program or test suite after the second `--`. For example, `cargo
+nightly miri run -- -Zmiri-disable-validation` runs the program without