1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-14 22:15:54 +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
Victor Costan 0b4891fb1f
Unified FFI setup for for readdir() on macOS (#857)
Unified FFI setup for for readdir() on macOS.
2023-06-23 15:48:18 +02:00
.github Run builds on both Mac OS and Linux (#830) 2023-06-22 10:38:41 +02:00
mdbook-exerciser Format files with dprint (#711) 2023-05-30 17:04:19 +02:00
po ja: Translate chapter 5 (#825) 2023-06-23 21:30:14 +09:00
src Unified FFI setup for for readdir() on macOS (#857) 2023-06-23 15:48:18 +02:00
theme Open GitHub edit links in new tabs (#856) 2023-06-22 09:50:20 -04:00
third_party Make User pub to avoid unused code warnings when running tests (#822) 2023-06-21 15:08:37 +01:00
.gitignore Additional Italian translation (#642) 2023-05-19 12:52:32 +01:00
aspect-ratio-helper.py Add an aspect-ratio-helper mdbook preprocessor (#187) 2023-01-27 18:30:37 +01:00
book.toml Remove ineffective LICENSE link (#850) 2023-06-22 16:27:56 +02:00
Cargo.lock build(deps): bump openssl from 0.10.49 to 0.10.55 (#849) 2023-06-22 09:04:44 +02: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 Exclude book/ directory from auto-formatting (#852) 2023-06-22 10:13:53 -04: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 Explicitly ask people to clone the repository (#808) 2023-06-13 11:01:12 +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 Simplify state transitions for speaker notes 2023-01-12 12:31:26 +01:00
STYLE.md Format files with dprint (#711) 2023-05-30 17:04:19 +02:00
svgbob.css Fix svgbob diagrams in dark mode 2022-12-27 17:04:14 +01:00
TRANSLATIONS.md Add PR labeler action to label translation-related PRs (#845) 2023-06-22 14:21:33 +09: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.