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
这是什么东西?Comprehensive Rust 是 Google Android 团队开发的为期多天的 Rust 课程,内容从基础语法一直讲到泛型和错误处理。
这是课程本身,还是课程背后的源代码?这个仓库存放的是课程的源代码。课程本身是一个 mdbook 网站,你可以直接在线阅读,也可以自己构建并在本地提供服务。
怎么在本地构建并运行这个课程?先安装 Rust,再通过 Bazelisk 安装 Bazel,克隆仓库,然后运行 'cargo xtask install-tools'。之后运行 'cargo xtask serve' 就会启动一个包含课程的本地网络服务器。
用它自学效果好吗?不太理想:自学者听不到课堂讨论、问答互动,也看不到配合代码示例展示的编译器报错。讲者备注和已发布的视频应该能改善这一点。
这门课程是写给谁看的?有经验的软件工程师,通常有 C++ 或 Java 背景。Google 内部使用这门课程,并以课堂授课的方式讲授。
如果我复用这些材料,许可条款是怎样的?采用双重许可:源代码和代码示例遵循 Apache 2.0,而 Markdown 文件、文档和图片等非代码内容遵循 CC BY 4.0。
这门课程是用哪些工具构建的?mdbook 加上一批插件,分别用于练习、SVG 图表、国际化和链接检查,整体由 Bazel 编排;'cargo xtask install-tools' 会把这些工具全部安装到 ~/.cargo/bin/ 里。
课程里有练习题吗?有,可运行的练习通过 mdbook-exerciser 成为工具链的一部分。如果做静态构建,则需要单独编译并打包练习到 book/html。
这门课程要学多久?README 称它是一门为期多天的课程。一个参考数据:2023 年有一所大学以它为基础开设了为期 5 天的 Rust 课程。
不构建任何东西的话,我在哪里可以阅读这门课程?渲染好的课程已发布在 google.github.io/comprehensive-rust,你用浏览器打开就能直接开始阅读。
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