comprehensive-rust – google
这是谷歌Android团队使用的Rust课程,为你提供快速教授Rust的材料。
关键指标一览
主题标签
README 详细介绍
Comprehensive Rust 🦀
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].
[Android]: https://google.github.io/comprehensive-rust/android.html
[Chromium]: https://google.github.io/comprehensive-rust/chromium.html
[bare-metal]: https://google.github.io/comprehensive-rust/bare-metal.html
[concurrency]: https://google.github.io/comprehensive-rust/concurrency.html
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:
- 2023-09-08:
_Teaching Rust in 5 days_.
Comprehensive Rust was used as a base for a 5-day university class on Rust.
- 2023-09-21:
_Scaling Rust Adoption Through Training_.
We published a blog post with details on the development of the course.
- 2023-10-02:
_In Search of Rust Developers, Companies Turn to In-House Training_.
About how Microsoft, Google, and others are training people in Rust.
- 2024-10-18:
_Rust Training at Scale | Rust Global @ RustConf 2024_.
What Google learned from teaching Comprehensive Rust for more than two years.
Setup
The course is built using a few tools:
- mdbook
- mdbook-svgbob
- mdbook-i18n-helpers and i18n-report
- mdbook-exerciser
- mdbook-course
- mdbook-linkcheck2
- Bazel
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-rustThen run the following command to install the correct versions of all tools
mentioned above:
cargo xtask install-toolsYou 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. Runcargo 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.
- Source Code: All source code files and code examples embedded in the
documentation are licensed under the Apache License, Version 2.0.
- Documentation & Content: All non-source code assets—specifically Markdown
(.md) files, documentation, and images—are licensed under 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.
