From 2ef399979b5801efb64c68b57ccb34007ad9b012 Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Fri, 8 Mar 2019 10:50:31 +0100 Subject: [PATCH] README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c11cb46b31d..aef74d6a5fe 100644 --- a/README.md +++ b/README.md @@ -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