1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-15 06:20:32 +02:00
This is the Rust course used by the Android team at Google. It provides you the material to quickly teach Rust.
Go to file
Martin Geisler 991c437986
Trim off licenses when showing solutions (#1212)
The licenses end up in the PO files, causing extra unnecessary for work
our translators. We save about 300 lines from each PO file with this.

This also solves another small problem: when a file is included with an
anchor, other anchors are automatically stripped away. This removes some
confusing `// ANCHOR: foo` and `// ANCHOR_END: foo` lines in the
solutions.
2023-09-18 11:56:55 +02:00
.github Sort language codes in publish.yml (#1193) 2023-09-11 10:15:04 -04:00
mdbook-exerciser Format files with dprint (#711) 2023-05-30 17:04:19 +02:00
po fr: removing references to Rust (as in... "iron oxide", "rouille" in French) (#1214) 2023-09-17 19:29:26 +00:00
src Trim off licenses when showing solutions (#1212) 2023-09-18 11:56:55 +02:00
theme Move JavaScript code to head template (#1210) 2023-09-15 09:52:22 +00:00
third_party Update mdbook to 0.4.34 (#1066) 2023-08-11 15:40:01 +02:00
.gitignore Additional Italian translation (#642) 2023-05-19 12:52:32 +01:00
aspect-ratio-helper.py Fix some minor typos (#910) 2023-07-06 08:39:47 +00:00
book.toml Reorder material on first two days (#913) 2023-08-25 17:42:31 +02:00
Cargo.lock Update dependencies in chat-app exercise (#1195) 2023-09-11 10:19:13 -04:00
Cargo.toml Beginnings of an async chat exercise (#627) 2023-05-16 15:51:01 +00:00
CONTRIBUTING.md Format files with dprint (#711) 2023-05-30 17:04:19 +02:00
dprint.json Update exec plugin to latest version (#1046) 2023-08-02 10:30:43 +01:00
language-picker.css Add support for right-to-left languages (#1165) 2023-09-07 09:50:44 +02:00
LICENSE Rename LICENSE.txt to LICENSE (#293) 2023-01-29 14:20:55 +01:00
poedit-screenshot.png Additional configuration steps on TRANSLATIONS.md (#959) 2023-07-13 11:00:46 +02:00
README.md remove $ from code blocks in README (#951) 2023-07-10 22:52:00 +00:00
rustfmt.toml Format files with dprint (#711) 2023-05-30 17:04:19 +02:00
speaker-notes.css Simplify state transitions for speaker notes 2023-01-12 12:31:26 +01:00
speaker-notes.js Fix print details toggle (#1048) 2023-08-02 15:42:42 +02:00
STYLE.md Remove hints about preserving reference links (#1138) 2023-08-30 09:21:43 +02:00
svgbob.css Fix svgbob diagrams in dark mode 2022-12-27 17:04:14 +01:00
TRANSLATIONS.md Fixed TRANSLATIONS.md link (#1071) 2023-08-13 13:37:38 +00:00

Comprehensive Rust 🦀

Build workflow GitHub contributors GitHub stars

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:

First clone the repository:

git clone https://github.com/google/comprehensive-rust/
cd comprehensive-rust

Then install these tools with:

cargo install mdbook
cargo install mdbook-svgbob
cargo install mdbook-i18n-helpers
cargo install --path mdbook-exerciser

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.

Note

On Windows, you need to enable symlinks (git config --global core.symlinks true) and Developer Mode.

Contact

For questions or comments, please contact Martin Geisler or start a discussion on GitHub. We would love to hear from you.