diff options
Diffstat (limited to '')
-rw-r--r-- | src/doc/rust-by-example/README.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/src/doc/rust-by-example/README.md b/src/doc/rust-by-example/README.md new file mode 100644 index 000000000..462f733e5 --- /dev/null +++ b/src/doc/rust-by-example/README.md @@ -0,0 +1,57 @@ +# Rust By Example + +[![Build Status][travis-badge]][travis-repo] + +[travis-badge]: https://travis-ci.com/rust-lang/rust-by-example.svg?branch=master +[travis-repo]: https://travis-ci.com/rust-lang/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: + +```bash +$ git clone https://github.com/rust-lang/rust-by-example +$ cd rust-by-example +$ cargo install mdbook +$ mdbook build +$ mdbook serve +``` + +[install Rust]: https://www.rust-lang.org/tools/install + +To be able to run the examples, you must be connected to the internet; you can +read all content offline, however! + +## Contributing + +Please see the [CONTRIBUTING.md] file for more details. + +[CONTRIBUTING.md]: https://github.com/rust-lang/rust-by-example/blob/master/CONTRIBUTING.md + +## Translations to other languages + +* [Chinese](https://github.com/rust-lang-cn/rust-by-example-cn) +* [Japanese](https://github.com/rust-lang-ja/rust-by-example-ja) +* [French](https://github.com/Songbird0/FR_RBE) +* [Russian](https://github.com/ruRust/rust-by-example) +* [Vietnamese](https://github.com/EyesCrypto-Insights/rust-by-example-vn) + +## License + +Rust by Example is licensed under either of + +* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or + <http://www.apache.org/licenses/LICENSE-2.0>) +* MIT license ([LICENSE-MIT](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. |