mirror of
https://github.com/google/comprehensive-rust.git
synced 2024-11-21 13:25:53 +02:00
1c964f6fe3
In #2153 I aimed to fix a link but broke it. In this PR, I fix it and add [`mdbook-linkcheck`](https://github.com/Michael-F-Bryan/mdbook-linkcheck) to avoid future cases. Some past fixes that could have been prevented, in addition to mine in this PR: * #811 * #2064 * #2146 Note: `mdbook-linkcheck` may also check external links with a configuration change. It can be beneficial to check also external links from time to time. I ran it here and found 3 broken links. Maintainers - sorry for the lack of a preceding issue. We can discuss it here. Some remaining work is to fix the outdated internal links in the translations, not done here. Let me know what you think about the proposed contribution. This PR completes #1502.
109 lines
4.5 KiB
Markdown
109 lines
4.5 KiB
Markdown
# Comprehensive Rust 🦀
|
|
|
|
[](https://github.com/google/comprehensive-rust/actions/workflows/build.yml?query=branch%3Amain)
|
|
[](https://github.com/google/comprehensive-rust/graphs/contributors)
|
|
[](https://github.com/google/comprehensive-rust/stargazers)
|
|
|
|
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 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](https://github.com/google/comprehensive-rust/issues/53) and by
|
|
[publishing videos](https://github.com/google/comprehensive-rust/issues/52).
|
|
|
|
## Press
|
|
|
|
Articles and blog posts from around the web which cover Comprehensive Rust:
|
|
|
|
- 2023-09-08:
|
|
_[Teaching Rust in 5 days](https://mo8it.com/blog/teaching-rust/)_.
|
|
Comprehensive Rust was used as a base for a 5-day university class on Rust.
|
|
- 2023-09-21:
|
|
_[Scaling Rust Adoption Through Training](https://security.googleblog.com/2023/09/scaling-rust-adoption-through-training.html)_.
|
|
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](https://www.darkreading.com/application-security/google-microsoft-take-refuge-in-rust-languages-better-security)_.
|
|
About how Microsoft, Google, and others are training people in Rust.
|
|
|
|
## Building
|
|
|
|
The course is built using a few tools:
|
|
|
|
- [mdbook](https://github.com/rust-lang/mdBook)
|
|
- [mdbook-svgbob](https://github.com/boozook/mdbook-svgbob)
|
|
- [mdbook-i18n-helpers and i18n-report](https://github.com/google/mdbook-i18n-helpers)
|
|
- [mdbook-exerciser](mdbook-exerciser/)
|
|
- [mdbook-course](mdbook-course/)
|
|
|
|
In addition,
|
|
[mdbook-linkcheck](https://github.com/Michael-F-Bryan/mdbook-linkcheck) checks
|
|
the internal links.
|
|
|
|
First install Rust by following the instructions on https://rustup.rs/. Then
|
|
clone this repository:
|
|
|
|
```shell
|
|
git clone https://github.com/google/comprehensive-rust/
|
|
cd comprehensive-rust
|
|
```
|
|
|
|
Then install these tools with:
|
|
|
|
```shell
|
|
cargo install mdbook
|
|
cargo install --locked mdbook-svgbob
|
|
cargo install --locked mdbook-i18n-helpers
|
|
cargo install --locked i18n-report
|
|
cargo install --locked mdbook-linkcheck
|
|
cargo install --locked --path mdbook-exerciser
|
|
cargo install --locked --path mdbook-course
|
|
```
|
|
|
|
Run
|
|
|
|
```shell
|
|
mdbook test
|
|
```
|
|
|
|
to test all included Rust snippets. Run
|
|
|
|
```shell
|
|
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. 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, run `MDBOOK_BOOK__LANGUAGE=xx mdbook build -d book/xx`
|
|
where `xx` is the ISO 639 language code (e.g. `da` for the Danish translation).
|
|
[TRANSLATIONS.md](TRANSLATIONS.md) contains further instructions.
|
|
|
|
> **Note** On Windows, you need to enable symlinks
|
|
> (`git config --global core.symlinks true`) and Developer Mode.
|
|
|
|
## Contact
|
|
|
|
For questions or comments, please contact
|
|
[Martin Geisler](mailto:mgeisler@google.com) or start a
|
|
[discussion on GitHub](https://github.com/google/comprehensive-rust/discussions).
|
|
We would love to hear from you.
|