README.md

   1 # Miri
   2
   3 [[slides](https://solson.me/miri-slides.pdf)]
   4 [[report](https://solson.me/miri-report.pdf)]
   5
   6 An experimental interpreter for [Rust][rust]'s [mid-level intermediate
   7 representation][mir] (MIR). This project began as part of my work for the
   8 undergraduate research course at the [University of Saskatchewan][usask].
   9
  10 ## Download Rust nightly
  11
  12 I currently recommend that you install [multirust][multirust] and then use it to
  13 install the current rustc nightly version that works with Miri:
  14
  15 ```sh
  16 multirust update nightly-2016-04-05
  17 ```
  18
  19 ## Build
  20
  21 ```sh
  22 multirust run nightly-2016-04-05 cargo build
  23 ```
  24
  25 ## Run a test
  26
  27 ```sh
  28 multirust run nightly-2016-04-05 cargo run -- \
  29   --sysroot $HOME/.multirust/toolchains/nightly-2016-04-05 \
  30   test/filename.rs
  31 ```
  32
  33 If you installed without using multirust, you'll need to adjust the command to
  34 run your cargo and set the `sysroot` to the directory where your rust compiler
  35 is installed (`$sysroot/bin/rustc` should be a valid path).
  36
  37 ## License
  38
  39 Licensed under either of
  40   * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
  41     http://www.apache.org/licenses/LICENSE-2.0)
  42   * MIT license ([LICENSE-MIT](LICENSE-MIT) or
  43     http://opensource.org/licenses/MIT) at your option.
  44
  45 ### Contribution
  46
  47 Unless you explicitly state otherwise, any contribution intentionally submitted
  48 for inclusion in the work by you shall be dual licensed as above, without any
  49 additional terms or conditions.
  50
  51 [rust]: https://www.rust-lang.org/
  52 [mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
  53 [usask]: https://www.usask.ca/
  54 [multirust]: https://github.com/brson/multirust