Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added setting nightly as a requirement for running tests #955

Merged
merged 1 commit into from
Jan 27, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ what we have for now.

- rustc (the Rust compiler).
- mdbook (use `cargo install mdbook` to install it).
- rust nightly (you would be required to set your Rust version to the nightly version to make sure all tests pass)

## Build steps

Expand All @@ -28,7 +29,22 @@ Change the directory to the downloaded repository:
```sh
cd reference
```
Run the following command to test the code snippets to catch compilation errors:

To run the tests, you would need to set the Rust version to the nightly release. You can do this by executing the following command:

```shell
rustup override set nightly
```

This will set the nightly version only for your the current project.

If you wish to set Rust nightly for all your projects, you can run the command:

```shell
rustup default nightly
```

Now, run the following command to test the code snippets to catch compilation errors:

```shell
mdbook test
Expand Down