1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-11-29 18:29:40 +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 84650b2af1
Add a style guide (#591)
This is an attempt at documenting some things to do and don’t do when
updating the course text or a translation.

Fixes #560.
2023-05-04 12:20:22 +02:00
.github Remove unnecessary cache key (#586) 2023-04-27 13:25:02 -04:00
mdbook-exerciser Rename exercise template directory and archive. 2023-04-05 16:28:07 +01:00
po First part of the French translation (#559) 2023-04-27 20:34:57 +02:00
src Move closures to the top level (#604) 2023-05-03 09:30:13 -04:00
theme Add book.js generated with mdbook init --theme 2023-03-01 13:14:42 +01:00
third_party Integrate GA4 code directly with book.js (#470) 2023-03-02 17:50:37 +00:00
.gitignore Make exerciser an mdbook renderer. 2023-04-05 16:28:07 +01:00
aspect-ratio-helper.py Add an aspect-ratio-helper mdbook preprocessor (#187) 2023-01-27 18:30:37 +01:00
book.toml Cleanup references to "Day 4" (#603) 2023-05-02 08:02:28 +02:00
Cargo.lock Bump h2 from 0.3.16 to 0.3.17 (#565) 2023-04-14 10:33:30 +01:00
Cargo.toml Rename directory to match crate name. 2023-04-05 16:28:07 +01:00
CONTRIBUTING.md Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +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 Cleanup references to "Day 4" (#603) 2023-05-02 08:02:28 +02:00
rustfmt.toml rustfmt with imports_granularity = "module". 2023-04-05 16:28:07 +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
STYLE.md Add a style guide (#591) 2023-05-04 12:20:22 +02:00
svgbob.css Fix svgbob diagrams in dark mode 2022-12-27 17:04:14 +01:00
TRANSLATIONS.md Add a style guide (#591) 2023-05-04 12:20:22 +02: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:

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.