This is the next iteration of “The Rust Programming Language”, which is currently located in the main Rust repository. If you want to read the book, you should check it out there or on the web.
If you would like to see this version rendered, it’s on GitHub pages.
Building the book requires mdBook >= v0.0.13. To get it:
$ cargo install mdbookTo build the book, type:
$ mdbook buildThe output will be in the book subdirectory. To check it out, open it in
your web browser.
Firefox:
$ firefox book/index.html # Linux
$ open -a "Firefox" book/index.html # OS XChrome:
$ google-chrome book/index.html # Linux
$ open -a "Google Chrome" book/index.html # OS XTo run the tests:
$ mdbook testI’m not going to be accepting major changes at first, but pull requests to fix typos and such are welcome. Please file any issues for any bugs you find.
This repository is under the same license as Rust itself, MIT/Apache2.
There are a number of labels on Issues:
Enhancementissues are a request for an improvement of some kind.Bugissues indicate problems in the text.Needs Backportwill be used when we are further along. At some point, we will import the text into their review system, and so changes made here will need to be upstreamed. This will track those.
As the book will be published by No Starch, we first iterate here, then ship the text off to No Starch. Then they do editing, and we fold it back in.
As such, there’s a directory, nostarch, which corresponds to the text in No Starch’s system.
When we've started working with No Starch in a word doc, we will also check those into the repo in the nostarch/odt directory. To extract the text from the word doc as markdown in order to backport changes to the online book:
- Open the doc file in LibreOffice
- Accept all tracked changes
- Save as Microsoft Word 2007-2013 XML (.docx) in the tmp directory
- Run
./doc-to-md.sh - Inspect changes made to the markdown file in the nostarch directory and copy the changes to the src directory as appropriate.