Improved the README

[ujh]

Recently a few people (e.g. @grosser & @xetra11) had issues with stainless mainly due to the lack of documentation. I've tried to clarify the README a bit. See here for how Github would render it.

• Added note about the fact that the nightly compiler build is required
• Added instructions on how to integrate stainless
• Reordered sections (overview before the example)
• Added before_each & after_each to the nested describe! in the example
• Clarified the pub use requirement

[grosser]

❤️

[reem]

this should be a dev-dependency

[reem]

Thanks for this. It looks great except for the one nit.

[ujh]

Oh yes, of course! Fixed.

[grosser]

followed the instructions ... still getting

hello.rs:7:5: 7:13 error: macro undefined: 'describe!'
hello.rs:7     describe! canvas_renderer {
               ^~~~~~~~

rustc --version
rustc 1.9.0-nightly (6e0f2f2f0 2016-03-16)

#![feature(plugin)]
#![cfg_attr(test, plugin(stainless))]

#[cfg(test)]
mod tests {
    pub use std::collections::HashMap;

    describe! stainless {
        it "can use HashMap" {
            let map = HashMap::new();
        }
    }
}

[ujh]

How are you running this? Via cargo test?

[grosser]

yep!

[grosser]

https://github.com/grosser/hello-rust

[ujh]

You haven't put the two lines at the top of hello.rs in your repo. This works for me:

[package]
name = "t"
version = "0.0.0"

[lib]
path = "hello.rs"

[dev-dependencies]
stainless = "*"

#![feature(plugin)]
#![cfg_attr(test, plugin(stainless))]

#[cfg(test)]
mod tests {
    pub use std::collections::HashMap;

    describe! stainless {
        it "can use HashMap" {
            let mut map = HashMap::new();
            map.insert(1, 1);
            assert!(map.contains_key(&1));
    }
    }
}

Compilation started at Sat Mar 19 19:56:06

cargo test
   Compiling t v0.0.0 (file:///Users/uh/t)
     Running target/debug/t-aede725b5ddfcc52

running 1 test
test tests::stainless::can_use_HashMap ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured

   Doc-tests t

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured


Compilation finished at Sat Mar 19 19:56:07

[grosser]

copy pasted these changes and still getting the same error :D

pushed it with the changes ... that version works for you ?

what rust version are you running ? ... I'm on rustc 1.9.0-nightly (6e0f2f2f0 2016-03-16)

[reem]

Thank you!

[xetra11]

thanks for that !