sleak07 / rust-by-example

Learn Rust with examples (Live code editor included)

Rust By Example

Learn Rust with examples (Live code editor included)

Using

If you'd like to read Rust by Example, you can visit https://doc.rust-lang.org/rust-by-example/ to read it online.

If you'd like to read it locally, install Rust, and then:

git clone https://github.com/rust-lang/rust-by-example
cd rust-by-example
cargo install mdbook
mdbook build
mdbook serve

To be able to run the examples, you must be connected to the internet; you can read all content offline, however!

The following warnings can be ignored safely.

[WARN] (mdbook::preprocess::cmd): The command wasn't found, is the "gettext" preprocessor installed?
[WARN] (mdbook::preprocess::cmd):   Command: mdbook-gettext

Using translated version

If there is a translated resource in po/ directory, it can be specified through MDBOOK_BOOK__LANGUAGE like below:

git clone https://github.com/rust-lang/rust-by-example
cd rust-by-example
cargo install mdbook
MDBOOK_BOOK__LANGUAGE=ja mdbook build
MDBOOK_BOOK__LANGUAGE=ja mdbook serve

Contributing

Please see the CONTRIBUTING.md file for more details.

Translating

Please see the TRANSLATING.md file for more details.

Translating guide for each languages

• Japanese/日本語: TRANSLATING_JA.md

Translations to other languages

• Bulgarian
• Chinese
• Japanese
• French
• Russian
• Vietnamese
• Portuguese

License

Rust by Example is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Rust by Example by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any additional terms or conditions.