1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-02 11:03:18 +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 3b7123d21a
Add language picker menu (#411)
The picker is a drop-down menu using the same design as the theme
picker in the top-left.

There doesn’t seem to be an easy way to pass in a list of languages
and descriptions, so for now we’ll have to expand the menu by hand as
we add new languages. A comment has been added to `publish.yml` to
remind us of this.
2023-02-15 15:10:16 +01:00
.github Add language picker menu (#411) 2023-02-15 15:10:16 +01:00
i18n-helpers Add a cargo workspace containing both crates (#321) 2023-02-02 16:14:34 +00:00
po Adds latest English changes to pt-BR translation (#396) 2023-02-14 18:43:00 +01:00
src Add Too Many Lists book to other resources (#410) 2023-02-14 21:25:06 +00:00
theme Add language picker menu (#411) 2023-02-15 15:10:16 +01:00
third_party Updates and minor fixes to Day 2: Morning (#372) 2023-02-09 21:15:47 +00:00
.gitignore Adds latest English changes to pt-BR translation (#396) 2023-02-14 18:43:00 +01:00
aspect-ratio-helper.py Add an aspect-ratio-helper mdbook preprocessor (#187) 2023-01-27 18:30:37 +01:00
book.toml Add language picker menu (#411) 2023-02-15 15:10:16 +01:00
Cargo.lock Add a cargo workspace containing both crates (#321) 2023-02-02 16:14:34 +00:00
Cargo.toml Add a cargo workspace containing both crates (#321) 2023-02-02 16:14:34 +00:00
CONTRIBUTING.md Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
ga4.js Move GA code directly into main page (#289) 2023-01-27 14:37:17 +01:00
language-picker.css Add language picker menu (#411) 2023-02-15 15:10:16 +01:00
LICENSE Rename LICENSE.txt to LICENSE (#293) 2023-01-29 14:20:55 +01:00
README.md Explain how the course can be used 2023-01-03 16:55:33 +01:00
rustfmt.toml Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
speaker-notes.css Simplify state transitions for speaker notes 2023-01-12 12:31:26 +01:00
speaker-notes.js Simplify state transitions for speaker notes 2023-01-12 12:31:26 +01:00
svgbob.css Fix svgbob diagrams in dark mode 2022-12-27 17:04:14 +01:00
TRANSLATIONS.md Add hint about using a PO editor (#356) 2023-02-06 20:17:36 +01:00

Comprehensive Rust 🦀

This repository has the source code for Comprehensive Rust 🦀, a four 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 Android-specific content on the last day.

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 mdBook and its Svgbob plugin. Install both tools with

$ cargo install mdbook
$ cargo install mdbook-svgbob

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.