aaca44f62b
The dprint formatter is a flexible system which will use sandboxed WebAssembly formatters to format our code (mostly: it calls out to `rustfmt` for Rust code). A particularly interesting feature is that dprint can format Rust code blocks in the Markdown files. However, before we turn that on, we need to have a way to normalize the Markdown text as it is extracted[1]. That is so that the word put into the translations is kept after the reformatting. [1]: https://github.com/google/mdbook-i18n-helpers/issues/19 |
||
|---|---|---|
| .github | ||
| mdbook-exerciser | ||
| po | ||
| src | ||
| theme | ||
| third_party | ||
| .gitignore | ||
| aspect-ratio-helper.py | ||
| book.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CONTRIBUTING.md | ||
| dprint.json | ||
| language-picker.css | ||
| LICENSE | ||
| README.md | ||
| rustfmt.toml | ||
| speaker-notes.css | ||
| speaker-notes.js | ||
| STYLE.md | ||
| svgbob.css | ||
| TRANSLATIONS.md | ||
Comprehensive Rust 🦀
This repository has the source code for Comprehensive Rust 🦀, a multi-day Rust course developed by the Android team. The course covers all aspects of Rust, from basic syntax to generics and error handling. It also includes deep dives on Android, bare-metal, and concurrency.
Read the course at https://google.github.io/comprehensive-rust/.
Course Format and Target Audience
The course is used internally at Google when teaching Rust to experienced software engineers. They typically have a background in C++ or Java.
The course is taught in a classroom setting and we hope it will be useful for others who want to teach Rust to their team. The course will be less useful for self-study since you miss out on the discussions happening in the classroom. You don't see the questions and answers and you don't see the compiler errors we trigger when going through the code samples. We hope to improve on this via speaker notes and by publishing videos.
Building
The course is built using a few tools:
Install these tools with:
$ cargo install mdbook
$ cargo install mdbook-svgbob
$ cargo install mdbook-i18n-helpers
$ cargo install --path mdbook-exerciser
Then run
$ mdbook test
to test all included Rust snippets. Run
$ mdbook serve
to start a web server with the course. You'll find the content on
http://localhost:3000. You can use mdbook build to create a static version
of the course in the book/ directory. Note that you have to separately build
and zip exercises and add them to book/html. To build any of the translated
versions of the course, run MDBOOK_BOOK__LANGUAGE=xx mdbook build -d book/xx
where xx is the ISO 639 language code (e.g. da for the Danish translation).
TRANSLATIONS.md contains further instructions.
Contact
For questions or comments, please contact Martin Geisler or start a discussion on GitHub. We would love to hear from you.