1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-04 03:25:08 +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 1f37933b8b
Extract common build steps to composite actions (#242)
* Extract common build steps to composite actions

This allows us to repeat ourselves less across the different jobs.

I also tested using a “reusable workflow” to factor out the common
steps. However, this starts a separate job without a shared
filesystem, which in turn requires us to upload/download artifacts
when we want to use them in several jobs. The artifacts are downloaded
one-by-one and this adds delays and extra steps to all jobs.

* Move Rust cache setup to its own build step

This made it easy to consistently setup the caching of our nested
projects via the “workspacs” config key.
2023-01-23 17:08:29 +01:00
.github/workflows Extract common build steps to composite actions (#242) 2023-01-23 17:08:29 +01:00
i18n-helpers Add support for translations 2023-01-18 16:12:53 +01:00
po Start a Danish translation 2023-01-18 16:12:53 +01:00
src Update result.md (#250) 2023-01-23 13:47:41 +00:00
third_party Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
.gitignore Add support for translations 2023-01-18 16:12:53 +01:00
book.toml Watch po/ directory for changes (#188) 2023-01-20 11:36:14 +01:00
Cargo.lock Bump tokio from 1.23.0 to 1.24.1 2023-01-06 22:02:55 +00:00
Cargo.toml Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
CONTRIBUTING.md Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
ga4.js Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
LICENSE.txt Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +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 support for translations 2023-01-18 16:12:53 +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.