readme: Add build and run instructions.

Author: solson

README.md

@@ -1,12 +1,35 @@
-# miri
+# Miri
 
-An experimental interpreter for [Rust][rust]'s [mid-level
-intermediate representation][mir] (MIR). This project is part of my course work
-for an undergraduate research course at the [University of Saskatchewan][usask].
+An experimental interpreter for [Rust][rust]'s [mid-level intermediate
+representation][mir] (MIR). This project began as a part of my course work for
+an undergraduate research course at the [University of Saskatchewan][usask].
 
-[rust]: https://www.rust-lang.org/
-[mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
-[usask]: https://www.usask.ca/
+## Download Rust nightly
+
+I currently recommend that you install [multirust][multirust] and then use it to
+install the current rustc nightly version that works with Miri:
+
+```sh
+multirust update nightly-2016-04-05
+```
+
+## Build
+
+```sh
+multirust run nightly-2016-04-05 cargo build
+```
+
+## Run a test
+
+```sh
+multirust run nightly-2016-04-05 cargo run -- \
+  --sysroot $HOME/.multirust/toolchains/nightly-2016-04-05
+  test/filename.rs
+```
+
+If you installed without using multirust, you'll need to adjust the command to
+run your cargo and set the `sysroot` to the directory where your rust compiler
+is installed (`$sysroot/bin/rustc` should be a valid path).
 
 ## License
 
@@ -21,3 +44,8 @@ Licensed under either of
 Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in the work by you shall be dual licensed as above, without any
 additional terms or conditions.
+
+[rust]: https://www.rust-lang.org/
+[mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
+[usask]: https://www.usask.ca/
+[multirust]: https://github.com/brson/multirust

test/arrays.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/bools.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/c_enums.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/calls.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/closures.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/errors.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/heap.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute, box_syntax)]
 #![allow(dead_code, unused_attributes)]
 

test/ints.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/loops.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/pointers.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/products.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/specialization.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute, specialization)]
 #![allow(dead_code, unused_attributes)]
 

test/std.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute, box_syntax)]
 #![allow(dead_code, unused_attributes)]
 

test/strings.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/sums.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/trivial.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]
 

test/vecs.rs

@@ -1,3 +1,4 @@
+#![crate_type = "lib"]
 #![feature(custom_attribute)]
 #![allow(dead_code, unused_attributes)]