The Rust Programming Language
This repository contains the source of "The Rust Programming Language" book.
You can also read the book for free online. Please see the book as shipped with the latest stable, beta, or nightly Rust releases. Be aware that issues in those versions may have been fixed in this repository already, as those releases are updated less frequently.
$ cargo install mdbook --vers [version-num]
To build the book, type:
$ mdbook build
The output will be in the
book subdirectory. To check it out, open it in
your web browser.
$ firefox book/index.html # Linux $ open -a "Firefox" book/index.html # OS X $ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell) $ start firefox.exe .\book\index.html # Windows (Cmd)
$ google-chrome book/index.html # Linux $ open -a "Google Chrome" book/index.html # OS X $ Start-Process "chrome.exe" .\book\index.html # Windows (PowerShell) $ start chrome.exe .\book\index.html # Windows (Cmd)
To run the tests:
$ mdbook test
We'd love your help! Please see CONTRIBUTING.md to learn about the kinds of contributions we're looking for.
We'd love help translating the book! See the Translations label to join in efforts that are currently in progress. Open a new issue to start working on a new language! We're waiting on mdbook support for multiple languages before we merge any in, but feel free to start!
We're using Graphviz for some of the diagrams in the
book. The source for those files live in the
dot directory. To turn a
file, for example,
dot/trpl04-01.dot into an
$ dot dot/trpl04-01.dot -Tsvg > src/img/trpl04-01.svg
In the generated SVG, remove the width and the height attributes from the
element and set the
viewBox attribute to
0.00 0.00 1000.00 1000.00 or other
values that don't cut off the image.
To scan source files for spelling errors, you can use the
script. It needs a dictionary of valid words, which is provided in
dictionary.txt. If the script produces a false positive (say, you used word
BTreeMap which the script considers invalid), you need to add this word to
dictionary.txt (keep the sorted order for consistency).