You've already forked comprehensive-rust
mirror of
https://github.com/google/comprehensive-rust.git
synced 2025-11-06 09:29:26 +02:00
Publish Comprehensive Rust 🦀
This commit is contained in:
40
README.md
Normal file
40
README.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Comprehensive Rust 🦀
|
||||
|
||||
This repository has the source code for Comprehensive Rust 🦀, a four 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
|
||||
Android-specific content on the last day.
|
||||
|
||||
## Building
|
||||
|
||||
The course is built using [mdBook](https://github.com/rust-lang/mdBook) and its
|
||||
[Svgbob plugin](https://github.com/boozook/mdbook-svgbob). Install both tools
|
||||
with
|
||||
|
||||
```shell
|
||||
$ cargo install mdbook
|
||||
$ cargo install mdbook-svgbob
|
||||
```
|
||||
|
||||
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
|
||||
of the course in the `book/` directory.
|
||||
|
||||
## 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.
|
||||
Reference in New Issue
Block a user