e19fc8bfd2
* Remove unnecessary jobs names They are inconsistent with the rest of the jobs and they overflow the horizontal space in the GitHub UI. * Remove unnecessary toolchain action The GitHub runners include rustup and a recent stable Rust. We only need to add the necessary target and we’re good to go. This removes a lot of warnings because the action used an outdated GitHub API: https://github.com/actions-rs/toolchain/issues/219 * Simplify job name The job is testing a single translation, so it should be singular. * Test English source with translations This simplifies the workflow a little and ensures that we get artifacts uploaded of the English version for every PR. * Avoid shell command chain GitHub actions supports setting the working directory directly. * Upload only the book artifact Right now, the artifacts all contain the same two top-level folders: html/ and exerciser/. The former is what we actually deploy, the second is a side-effect of the exerciser plugin. With this change, we only upload the HTML and we ensure the zip file for the xx language has a top-level comprehensive-rust-xx/ folder. This makes it much nicer to use the generated artifacts. |
||
|---|---|---|
| .github | ||
| mdbook-exerciser | ||
| po | ||
| src | ||
| theme | ||
| third_party | ||
| .gitignore | ||
| aspect-ratio-helper.py | ||
| book.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CONTRIBUTING.md | ||
| 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.
Contact
For questions or comments, please contact Martin Geisler or start a discussion on GitHub. We would love to hear from you.