rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-11-26 01:30:22 +02:00
Code Issues Releases Activity
5de9cdafea
comprehensive-rust/README.md

75 lines
3.1 KiB
Markdown
Raw Normal View History

Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
# Comprehensive Rust 🦀
Link badges to the `main` branch (#636) This is the only branch for which there is any expectation of stability, so it makes sense to send people here.
2023-05-16 00:12:10 +02:00
[![Build workflow](https://img.shields.io/github/actions/workflow/status/google/comprehensive-rust/build.yml?style=flat-square)](https://github.com/google/comprehensive-rust/actions/workflows/build.yml?query=branch%3Amain)
Add badges to README and welcome page (#481)
2023-03-07 14:45:00 +02:00
[![GitHub contributors](https://img.shields.io/github/contributors/google/comprehensive-rust?style=flat-square)](https://github.com/google/comprehensive-rust/graphs/contributors)
[![GitHub stars](https://img.shields.io/github/stars/google/comprehensive-rust?style=flat-square)](https://github.com/google/comprehensive-rust/stargazers)
Cleanup references to "Day 4" (#603) * Align outline with new spin-off course structure With the new structure, the section on Android is a spin-off course from the main 3-day course on Rust Fundamentals. The Bare-metal and Concurrency days are spin-off courses in the same way. * Explain new course structure * Align Bare-Metal welcome page with other deep dives * Merge Day 4 page into Course Structure page * Remove Day 4 Welcome page This aligns the Concurrency in Rust section with the Bare-Metal Rust deep dive. * Show subsections for Android deep dive This aligns the Rust in Android section with the other deep dives. * Clean up welcome page and README We now cover async Rust and the course is no longer a four day course. * Remove reference to the old Day 4 * Remove Day 4 references from exercises
2023-05-02 08:02:28 +02:00
This repository has the source code for Comprehensive Rust 🦀, a multi-day Rust
Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
course developed by the Android team. The course covers all aspects of Rust,
Cleanup references to "Day 4" (#603) * Align outline with new spin-off course structure With the new structure, the section on Android is a spin-off course from the main 3-day course on Rust Fundamentals. The Bare-metal and Concurrency days are spin-off courses in the same way. * Explain new course structure * Align Bare-Metal welcome page with other deep dives * Merge Day 4 page into Course Structure page * Remove Day 4 Welcome page This aligns the Concurrency in Rust section with the Bare-Metal Rust deep dive. * Show subsections for Android deep dive This aligns the Rust in Android section with the other deep dives. * Clean up welcome page and README We now cover async Rust and the course is no longer a four day course. * Remove reference to the old Day 4 * Remove Day 4 references from exercises
2023-05-02 08:02:28 +02:00
from basic syntax to generics and error handling. It also includes deep dives on
[Android], [bare-metal], and [concurrency].
Fix broken README links (#629) Links inside the course are automatically turned into `.html` by mdbook, but this is a regular README and so we need proper links.
2023-05-11 14:37:35 +02:00
[Android]: https://google.github.io/comprehensive-rust/android.html
[bare-metal]: https://google.github.io/comprehensive-rust/bare-metal.html
[concurrency]: https://google.github.io/comprehensive-rust/concurrency.html
Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
Add link to course material
2022-12-21 19:37:55 +02:00
Read the course at **https://google.github.io/comprehensive-rust/**.
Explain how the course can be used From a discussion on Twitter: https://twitter.com/bluxte/status/1610297443324727298.
2023-01-03 17:40:37 +02:00
## 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).
Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
## Building
Make `i18n-helpers` a requirement (#461) * Make i18n-helpers a requirement * Skip mdbook-gettext for mdbook-xgettext * Gettext finds PO file based on `book.language` * Update workflow No need to set `preprocessor.gettext.po-file`. --------- Co-authored-by: Jooyung Han <jooyung@google.com>
2023-02-28 15:05:09 +02:00
The course is built using a few tools:
Format files with `dprint` (#711) The dprint formatter is a flexible system which will use sandboxed WebAssembly formatters to format our code (mostly: it calls out to `rustfmt` for Rust code). A particularly interesting feature is that dprint can format Rust code blocks in the Markdown files. However, before we turn that on, we need to have a way to normalize the Markdown text as it is extracted[1]. That is so that the word put into the translations is kept after the reformatting. [1]: https://github.com/google/mdbook-i18n-helpers/issues/19
2023-05-30 17:04:19 +02:00
Use mdbook-i18n-helpers crate (#552) The i18n-helpers are now available as a stand-alone crate: https://crates.io/crates/mdbook-i18n-helpers. Because we cache the Rust binaries in our GitHub workflows, I bumped the cache prefix to ensure we use a clean cache. Otherwise, Cargo won’t install the new binaries in mdbook-i18n-helpers because it sees the old ones from this repository.
2023-04-05 16:08:11 +02:00
- [mdbook](https://github.com/rust-lang/mdBook)
- [mdbook-svgbob](https://github.com/boozook/mdbook-svgbob)
Upgrade mdbook-i18n-helpers link (#626)
2023-05-11 15:55:43 +02:00
- [mdbook-i18n-helpers](https://github.com/google/mdbook-i18n-helpers)
Fixes in the README (#623)
2023-05-09 14:43:29 +02:00
- [mdbook-exerciser](mdbook-exerciser/)
Make `i18n-helpers` a requirement (#461) * Make i18n-helpers a requirement * Skip mdbook-gettext for mdbook-xgettext * Gettext finds PO file based on `book.language` * Update workflow No need to set `preprocessor.gettext.po-file`. --------- Co-authored-by: Jooyung Han <jooyung@google.com>
2023-02-28 15:05:09 +02:00
Use mdbook-i18n-helpers crate (#552) The i18n-helpers are now available as a stand-alone crate: https://crates.io/crates/mdbook-i18n-helpers. Because we cache the Rust binaries in our GitHub workflows, I bumped the cache prefix to ensure we use a clean cache. Otherwise, Cargo won’t install the new binaries in mdbook-i18n-helpers because it sees the old ones from this repository.
2023-04-05 16:08:11 +02:00
Install these tools with:
Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
```shell
$ cargo install mdbook
$ cargo install mdbook-svgbob
Use mdbook-i18n-helpers crate (#552) The i18n-helpers are now available as a stand-alone crate: https://crates.io/crates/mdbook-i18n-helpers. Because we cache the Rust binaries in our GitHub workflows, I bumped the cache prefix to ensure we use a clean cache. Otherwise, Cargo won’t install the new binaries in mdbook-i18n-helpers because it sees the old ones from this repository.
2023-04-05 16:08:11 +02:00
$ cargo install mdbook-i18n-helpers
Run exerciser as mdbook renderer.
2023-04-03 17:18:32 +02:00
$ cargo install --path mdbook-exerciser
Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
```
Then 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
Fixes in the README (#623)
2023-05-09 14:43:29 +02:00
of the course in the `book/` directory. Note that you have to separately build
Add instructions to build translations (#669) * Add instructions to build translations * Update README.md --------- Co-authored-by: Martin Geisler <mgeisler@google.com>
2023-05-24 20:39:49 +02:00
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.
Format files with `dprint` (#711) The dprint formatter is a flexible system which will use sandboxed WebAssembly formatters to format our code (mostly: it calls out to `rustfmt` for Rust code). A particularly interesting feature is that dprint can format Rust code blocks in the Markdown files. However, before we turn that on, we need to have a way to normalize the Markdown text as it is extracted[1]. That is so that the word put into the translations is kept after the reformatting. [1]: https://github.com/google/mdbook-i18n-helpers/issues/19
2023-05-30 17:04:19 +02:00
Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
## Contact
Format files with `dprint` (#711) The dprint formatter is a flexible system which will use sandboxed WebAssembly formatters to format our code (mostly: it calls out to `rustfmt` for Rust code). A particularly interesting feature is that dprint can format Rust code blocks in the Markdown files. However, before we turn that on, we need to have a way to normalize the Markdown text as it is extracted[1]. That is so that the word put into the translations is kept after the reformatting. [1]: https://github.com/google/mdbook-i18n-helpers/issues/19
2023-05-30 17:04:19 +02:00
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.
Reference in New Issue Copy Permalink