Skip to content

Commit 29afc84

Browse files
authored
Merge pull request rust-lang#109 from oli-obk/patch-2
add docs for `cargo miri`
2 parents 3fe4557 + 02a6937 commit 29afc84

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,13 @@ environment variable to `trace`. These traces are indented based on call stack
4747
depth. You can get a much less verbose set of information with other logging
4848
levels such as `warn`.
4949

50+
## Running miri on your own project('s test suite)
51+
52+
Install miri as a cargo subcommand with `cargo install --debug`.
53+
Then, inside your own project, use `cargo +nightly miri` to run your project, if it is
54+
a bin project, or run `cargo +nightly miri test` to run all tests in your project
55+
through miri.
56+
5057
## Contributing and getting help
5158

5259
Check out the issues on this GitHub repository for some ideas. There's lots that

0 commit comments

Comments
 (0)