From b0b1014599c98d90541844527abf6af817116d70 Mon Sep 17 00:00:00 2001 From: saki-osive Date: Wed, 27 Jan 2021 22:49:34 +0530 Subject: [PATCH] Added setting nightly as a requirement for running tests --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 45adfa4ed..ca6e5a67c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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