rust
/
reference
mirror of https://github.com/rust-lang/reference
1
0
Fork 0
Code Issues Releases Wiki Activity
1,526 Commits 4 Branches 0 Tags 8.7 MiB
Rust 46.1%
HTML 42.5%
CSS 11.4%
Go to file
Eric Huss b0e0ad6490 Update to mdbook 0.3. 
This updates to mdbook 0.3 which uses relative links, which are much better
(the pages mostly work when viewing on GitHub for example).
 		2019-07-15 16:51:25 -07:00
src Update to mdbook 0.3. 2019-07-15 16:51:25 -07:00
stable-check Removed copyright notices & made cosmetic improvements. 2019-01-13 02:27:39 +00:00
tests Fix tidy error. 2019-03-21 14:37:30 -07:00
theme Update to mdbook 0.3. 2019-07-15 16:51:25 -07:00
.gitattributes Fix tidy on Windows 2017-04-06 01:52:45 +03:00
.gitignore Start the port of the reference to mdBook 2017-03-02 14:57:36 -08:00
.travis.yml Update to mdbook 0.3. 2019-07-15 16:51:25 -07:00
CONTRIBUTING.md Some minor contributing updates. 2019-03-19 14:51:09 -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 Added basic README.md with build instructions 2017-07-15 13:38:22 -03:00
book.toml Update to mdbook 0.3. 2019-07-15 16:51:25 -07:00
reference.md Redirect to the new reference 2017-03-02 14:57:38 -08: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 docs folder.