comprehensive-rust README

The project's README from github.com/google/comprehensive-rust. As one markdown file: README.md.

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 to teach Rust to experienced software engineers, typically with 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 is less ideal for self-study, since you would miss out on classroom discussions. You would not see the questions and answers, nor the compiler errors we trigger when going through the code samples. We hope to improve the self-study experience via speaker notes and by publishing videos.

Press

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

Setup

The course is built using a few tools:

First, install Rust by following the instructions on https://rustup.rs/. Next, install Bazel via the Bazelisk version manager. Then clone this repository:

git clone https://github.com/google/comprehensive-rust/
cd comprehensive-rust

Then run the following command to install the correct versions of all tools mentioned above:

cargo xtask install-tools

You will find the tools in your ~/.cargo/bin/ directory afterwards.

Commands

Here are some of the commonly used commands you can run in the project. Run cargo xtask to view all available commands.

Command Description
cargo xtask install-tools Install all the tools the project depends on.
cargo xtask serve Start a web server with the course. You'll find the content on http://localhost:3000. To serve any of the translated versions of the course, add the language flag (--language or -l) followed by xx, where xx is the ISO 639 language code (e.g. cargo xtask serve -l da for the Danish translation).
cargo xtask rust-tests Test the included Rust snippets.
cargo xtask web-tests Run the web driver tests in the tests directory.
cargo xtask build 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, add the language flag (--language or -l) followed by xx, where xx is the ISO 639 language code (e.g. cargo xtask build -l 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.

Contributing

We welcome contributions. Please see CONTRIBUTING.md for details.

License

This project is licensed under a mix of the Apache License 2.0 and the Creative Commons Attribution 4.0 International License.

Contact

For questions or comments, please contact Martin Geisler or start a discussion on GitHub. We would love to hear from you.

comprehensive-rust (google/comprehensive-rust)

Searching Database…

33.4K ·GitHub
Comprehensive-rust
What is this?Comprehensive Rust is a multi-day Rust course developed by the Android team at Google, covering Rust from basic syntax to generics and error handling.
Is this the course itself or just the source code behind it?This repo holds the course's source code. The course itself is an mdbook website, so you can read it online or build and serve your own copy.
How do I build and serve the course locally?Install Rust, install Bazel via Bazelisk, clone the repo, then run 'cargo xtask install-tools'. After that 'cargo xtask serve' starts a local web server with the course.
Does it work for self-study?It's less ideal: self-learners miss the classroom discussions, the questions and answers, and the compiler errors shown with the code samples. Speaker notes and published videos should improve this.
Who is the course written for?Experienced software engineers, typically with a C++ or Java background. Google uses it internally and teaches it in a classroom setting.
If I reuse the material, what do the license terms look like?It's dual-licensed: source code and code examples are Apache 2.0, while non-code content like Markdown files, documentation and images is CC BY 4.0.
What tools is the course built with?mdbook plus plugins for exercises, SVG diagrams, i18n and link checking, orchestrated with Bazel; 'cargo xtask install-tools' installs them all into ~/.cargo/bin/.
Does the course include exercises?Yes, runnable exercises are part of the toolchain via mdbook-exerciser. For a static build you compile and zip the exercises separately into book/html.
How long does the course take?The README calls it a multi-day course. As a data point, a university used it as the base for a 5-day Rust class in 2023.
Where can I read the course without building anything?The rendered course is published online at google.github.io/comprehensive-rust, so you can start reading it in a browser right away.
What are similar projects?gotraining, rust-learning, RustTraining, GolangTraining, cs249r_book, IntelliJ-IDEA-Tutorial, practical-python, rust-course
Which topics is it in?training-materials, teaching, chromium, training, concurrency, curriculum, embedded, google, course, programming, i18n, guide
Creator
google
Size
28.4 MB
Stars
33.4K
Updated
CommitOct 06
Age
3y
Commits · 90 Days