README.md
1# The Rust Language Reference
2
3This document is the primary reference for the Rust programming language.
4
5This document is not normative. It may include details that are specific
6to `rustc` itself, and should not be taken as a specification for the
7Rust language. We intend to produce such a document someday, but this is
8what we have for now.
9
10## Dependencies
11
12- rustc (the Rust compiler).
13- mdbook (use `cargo install mdbook` to install it).
14- rust nightly (you would be required to set your Rust version to the nightly version to make sure all tests pass)
15
16## Build steps
17
18To build the project, follow the steps given below :
19
20Clone the project by downloading the ZIP from the [GitHub page](https://github.com/rust-lang/reference) or
21run the following command:
22
23```
24git clone https://github.com/rust-lang/reference
25```
26
27Change the directory to the downloaded repository:
28
29```sh
30cd reference
31```
32
33To run the tests, you would need to set the Rust version to the nightly release. You can do this by executing the following command:
34
35```shell
36rustup override set nightly
37```
38
39This will set the nightly version only for your the current project.
40
41If you wish to set Rust nightly for all your projects, you can run the command:
42
43```shell
44rustup default nightly
45```
46
47Now, run the following command to test the code snippets to catch compilation errors:
48
49```shell
50mdbook test
51```
52
53
54To generate a local instance of the book, run:
55
56```sh
57mdbook build
58```
59
60The generated HTML will be in the `book` folder.
61