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
Dustin J. Mitchell 4c0833a22e
Comment PRs with updated schedule information (#1576)
This adds a GH action to add a comment to every PR giving the updated
course schedule with the PR merged.

To accomplish this, I broke `mdbook-course` into a library and two
binaries, allowing the mdbook content to be loaded dynamically outside
of an `mdbook build` invocation.

I think this is a net benefit, but possible improvements include:
* diffing the "before" and "after" schedules and only making the comment
when those are not the same (or replacing the comment with "no schedule
changes")
* including per-segment timing behind `<details>` (with a few minutes
effort I couldn't get this to play nicely with the markdown lists)

---------

Co-authored-by: Martin Geisler <mgeisler@google.com>
2024-01-12 15:53:09 +00:00
.github Comment PRs with updated schedule information (#1576) 2024-01-12 15:53:09 +00:00
mdbook-course Comment PRs with updated schedule information (#1576) 2024-01-12 15:53:09 +00:00
mdbook-exerciser build(deps): bump anyhow from 1.0.76 to 1.0.79 (#1653) 2024-01-05 13:24:05 +00:00
po ja: refresh ja.po file (#1676) 2024-01-10 21:15:02 +09:00
src Comment PRs with updated schedule information (#1576) 2024-01-12 15:53:09 +00:00
theme Update mdbook and mdbook-i18n-helpers (#1658) 2024-01-05 15:56:18 +01:00
third_party Test translations using same source as for publish (#1492) 2024-01-04 17:04:44 +01:00
.gitignore Comprehensive Rust v2 (#1073) 2023-11-29 16:39:24 +01:00
aspect-ratio-helper.py Format Python files with YAPF (#1360) 2023-10-18 13:56:05 -04:00
book.toml fix mdbook redirection table (#1635) 2024-01-04 14:05:49 +00:00
Cargo.lock build(deps): bump serde_json from 1.0.109 to 1.0.111 (#1668) 2024-01-08 10:13:03 +00:00
Cargo.toml Comprehensive Rust v2 (#1073) 2023-11-29 16:39:24 +01:00
CONTRIBUTING.md Update Windows Gettext installation instructions (#1447) 2023-11-06 13:05:13 -08:00
dprint.json Test translations using same source as for publish (#1492) 2024-01-04 17:04:44 +01:00
LICENSE Rename LICENSE.txt to LICENSE (#293) 2023-01-29 14:20:55 +01:00
README.md Add Chromium section (#1479) 2023-11-27 18:21:19 +00:00
rustfmt.toml Format all Markdown files with dprint (#1157) 2023-12-31 00:15:07 +01:00
STYLE.md Add guidance that variable names shouldn't be translated to STYLE.md (#1480) 2023-11-15 10:25:46 -08:00
TRANSLATIONS.md build(deps): bump actions/labeler from 4 to 5 (#1619) 2024-01-01 21:57:24 -05: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, Chromium, 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.

Press

Articles and blog posts from around the web which cover Comprehensive Rust:

Building

The course is built using a few tools:

First install Rust by following the instructions on https://rustup.rs/. Then clone this 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
cargo install --path mdbook-course

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.