README.md

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