Skip to content

Commit 61c05bb

Browse files
committed
Update README.md to reflect changes to features
1 parent e42efed commit 61c05bb

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,18 @@ To use `compiletest-rs` in your application, add the following to `Cargo.toml`
1717
compiletest_rs = "*"
1818
```
1919

20-
This will require you to use rust nightly. If you want to use rust stable
21-
set the feature `stable`:
20+
By default, `compiletest-rs` should be able to run on both stable, beta and
21+
nightly channels of rust. We use the [`tester`](tester) fork of Rust's builtin
22+
`test` crate, so that we don't have require nightly. If you are running nightly
23+
and want to use Rust's `test` crate directly, you to have the rustc development
24+
libraries install (which you can get by running `rustup component add rustc-dev
25+
--target nightly`). Once you have the rustc development libraries installed, you
26+
can use the `rustc` feature to make compiletest use them instead of the `tester`
27+
crate.
2228

2329
```toml
2430
[dev-dependencies]
25-
compiletest_rs = { version = "*", features = [ "stable" ] }
31+
compiletest_rs = { version = "*", features = [ "rustc" ] }
2632
```
2733

2834
Create a `tests` folder in the root folder of your project. Create a test file
@@ -112,3 +118,4 @@ If you are unsure, open a pull request anyway and we would be glad to help!
112118
[upstream]: https://github.com/rust-lang/rust/tree/master/src/tools/compiletest
113119
[src]: https://github.com/rust-lang/rust/tree/master/src/tools/compiletest/src
114120
[tests]: https://rust-lang.github.io/rustc-guide/tests/adding.html#header-commands-configuring-rustc
121+
[tester]: https://crates.io/crates/tester

0 commit comments

Comments
 (0)