1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-02 02:56:26 +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 ba28dd2d4c
Parse Markdown in mdbook-xgettext (#449)
* Parse Markdown to support translation.

This upgrades from just splitting Markdown files on double-newlines, to
using a Markdown parser to break them into more appropriate chunks. The
upshot is that code samples are all in one message, lists are bundled
together, and generally it should be easier to translate.

* [WIP] helper to update po files for new translation

* process synthetic input file-by-file

* review comments

* remove temporary code

* fix msgfmt lints
2023-03-07 18:07:07 +00:00
.github Update mdbook to 0.4.28 (#480) 2023-03-07 10:14:26 +01:00
i18n-helpers Parse Markdown in mdbook-xgettext (#449) 2023-03-07 18:07:07 +00:00
po Parse Markdown in mdbook-xgettext (#449) 2023-03-07 18:07:07 +00:00
src Create default.md (#370) 2023-03-07 17:11:43 +01: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 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 Integrate GA4 code directly with book.js (#470) 2023-03-02 17:50:37 +00:00
Cargo.lock Parse Markdown in mdbook-xgettext (#449) 2023-03-07 18:07:07 +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
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 Add badges to README and welcome page (#481) 2023-03-07 12:45:00 +00: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 note about fuzzy and fix heading nesting (#466) 2023-03-01 09:17:41 +00:00

Comprehensive Rust 🦀

Build workflow GitHub contributors GitHub stars

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 a few tools:

Install these tools with

$ cargo install mdbook
$ cargo install mdbook-svgbob
$ cargo install --path i18n-helpers

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.