📄 README.md

Rust By Example

Learn Rust with examples (Live code editor included)

Using

If you'd like to read Rust by Example, you can visit 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 The command `mdbook-gettext` for preprocessor `gettext` was not found, but is marked as optional.

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]

Chinese/中文: [TRANSLATING_ZH.md]

Translations to other languages

License

Rust by Example is licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or

)

MIT license (LICENSE-MIT or

)

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.