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 — это многодневный курс по Rust, разработанный командой Android в Google. Он охватывает язык от базового синтаксиса до обобщений (generics) и обработки ошибок.
Это сам курс или только исходный код, на котором он построен?В этом репозитории лежит исходный код курса. Сам курс — это сайт на mdbook, так что его можно читать онлайн либо собрать и запустить собственную копию.
Как собрать и запустить курс локально?Установите Rust, установите Bazel через Bazelisk, склонируйте репозиторий и выполните 'cargo xtask install-tools'. После этого команда 'cargo xtask serve' запускает локальный веб-сервер с курсом.
Подходит ли курс для самостоятельного изучения?Это не идеально: самостоятельные ученики не видят обсуждений в аудитории, вопросов и ответов, а также ошибок компилятора, которые показывают вместе с примерами кода. Заметки докладчиков и опубликованные видео должны это исправить.
Для кого написан этот курс?Для опытных разработчиков, обычно с бэкграундом на C++ или Java. Google использует его внутри компании и преподаёт в формате занятий с преподавателем.
Если я захочу переиспользовать материалы, какие там условия лицензии?Двойная лицензия: исходный код и примеры кода — под Apache 2.0, а некодовый контент, такой как Markdown-файлы, документация и изображения, — под CC BY 4.0.
С помощью каких инструментов собран курс?mdbook плюс плагины для упражнений, SVG-диаграмм, i18n и проверки ссылок, всё управляется через Bazel; команда 'cargo xtask install-tools' устанавливает их все в ~/.cargo/bin/.
Есть ли в курсе упражнения?Да, выполняемые упражнения входят в набор инструментов через mdbook-exerciser. Для статической сборки упражнения нужно отдельно скомпилировать и упаковать в zip в book/html.
Сколько времени занимает курс?В README он назван многодневным курсом. Для ориентира: в 2023 году один университет использовал его как основу пятидневного курса по 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