rust
/
reference
mirror of https://github.com/rust-lang/reference
1
0
Fork 0
Code Issues Releases Wiki Activity
1,929 Commits 4 Branches 0 Tags 8.6 MiB
Rust 46.1%
HTML 42.5%
CSS 11.4%
Go to file
Havvy (Ryan Scheel) c272cca5ec Add stable-check to ignore. 2020-11-11 21:53:45 -08:00
.github/workflows Update deprecated GitHub Actions commands. 2020-10-17 09:34:55 -07:00
src Merge pull request #899 from Havvy/tuple 2020-11-11 19:13:21 -08:00
style-check Add more style checks. 2020-09-15 12:02:02 -07:00
theme Remove the warning that appears on every page. 2019-09-26 09:07:43 -07:00
.gitattributes Fix tidy on Windows 2017-04-06 01:52:45 +03:00
.gitignore Add stable-check to ignore. 2020-11-11 21:53:45 -08:00
CONTRIBUTING.md Grammar fix 2020-07-27 17:41:32 -07:00
LICENSE-APACHE manual -> reference & formatting 2017-03-02 14:56:49 -08:00
LICENSE-MIT manual -> reference & formatting 2017-03-02 14:56:49 -08:00
README.md Update README.md 2020-08-03 09:35:05 +02:00
STYLE.md Add more style checks. 2020-09-15 12:02:02 -07:00
book.toml Update organization name 2019-11-07 08:59:05 +09:00
reference.md Redirect to the new reference 2017-03-02 14:57:38 -08:00
triagebot.toml Enable triagebot 2020-07-28 18:11:36 -07:00

README.md

The Rust Language Reference

This document is the primary reference for the Rust programming language.

This document is not normative. It may include details that are specific to rustc itself, and should not be taken as a specification for the Rust language. We intend to produce such a document someday, but this is what we have for now.

Dependencies

  • rustc (the Rust compiler).
  • mdbook (use cargo install mdbook to install it).

Build steps

First, go to the repository folder and test the code snippets to catch compilation errors:

cd reference
mdbook test

And then generate the book:

mdbook build

The generated HTML will be in the book folder.