Skip to content

Commit 99cf04f

Browse files
authored
Merge pull request rust-lang#81 from brauliobezerra/readme
Added basic README.md with build instructions
2 parents 1abfbaa + 857c457 commit 99cf04f

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# The Rust Language Reference
2+
3+
This document is the primary reference for the Rust programming language.
4+
5+
This document is not normative. It may include details that are specific
6+
to `rustc` itself, and should not be taken as a specification for the
7+
Rust language. We intend to produce such a document someday, but this is
8+
what we have for now.
9+
10+
## Dependencies
11+
12+
- rustc (the Rust compiler).
13+
- mdbook (use `cargo install mdbook` to install it).
14+
15+
## Build steps
16+
17+
First, go to the repository folder and test the code snippets to catch
18+
compilation errors:
19+
20+
```bash
21+
cd reference
22+
mdbook test
23+
```
24+
25+
And then generate the book:
26+
27+
```bash
28+
mdbook build
29+
```
30+
31+
The generated HTML will be in the `docs` folder.

0 commit comments

Comments
 (0)