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-11
  14 ```
  15
  16 ## Build
  17
  18 ```sh
  19 multirust run nightly-2016-04-11 cargo build
  20 ```
  21
  22 ## Run a test
  23
  24 ```sh
  25 multirust run nightly-2016-04-11 cargo run -- \
  26   --sysroot $HOME/.multirust/toolchains/nightly-2016-04-11 \
  27   test/filename.rs
  28 ```
  29
  30 If you are using [rustup][rustup] (the name of the multirust rewrite in Rust),
  31 the `sysroot` path will also include your build target (e.g.
  32 `$HOME/.multirust/toolchains/nightly-2016-04-11-x86_64-apple-darwin`). You can
  33 see the current toolchain's directory by running `rustup which cargo` (ignoring
  34 the trailing `/bin/cargo).
  35
  36 If you installed without using multirust or rustup, you'll need to adjust the
  37 command to run your cargo and set the `sysroot` to the directory where your
  38 Rust compiler is installed (`$sysroot/bin/rustc` should be a valid path).
  39
  40 ## License
  41
  42 Licensed under either of
  43   * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
  44     http://www.apache.org/licenses/LICENSE-2.0)
  45   * MIT license ([LICENSE-MIT](LICENSE-MIT) or
  46     http://opensource.org/licenses/MIT) at your option.
  47
  48 ### Contribution
  49
  50 Unless you explicitly state otherwise, any contribution intentionally submitted
  51 for inclusion in the work by you shall be dual licensed as above, without any
  52 additional terms or conditions.
  53
  54 [rust]: https://www.rust-lang.org/
  55 [mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
  56 [usask]: https://www.usask.ca/
  57 [multirust]: https://github.com/brson/multirust
  58 [rustup]: https://www.rustup.rs