src/doc/rust-by-example/README.md

   1 # Rust By Example
   2
   3 [![Build Status](https://travis-ci.org/rust-lang/rust-by-example.svg?branch=master)](https://travis-ci.org/rust-lang/rust-by-example)
   4
   5 Learn Rust with examples (Live code editor included)
   6
   7 ## Using
   8
   9 If you'd like to read Rust by Example, you can visit
  10 [https://rustbyexample.com/](https://rustbyexample.com/) to read it online.
  11
  12 If you'd like to read it locally, [install Rust], and then:
  13
  14 ```bash
  15 $ git clone https://github.com/rust-lang/rust-by-example
  16 $ cd rust-by-example
  17 $ cargo install mdbook
  18 $ mdbook build
  19 $ mdbook serve
  20 ```
  21
  22 [install Rust]: http://rust-lang.org/install.html
  23
  24 To be able to run the examples, you must be connected to the internet; you can
  25 read all content offline, however!
  26
  27 ## Contributing
  28
  29 Please see the [CONTRIBUTING.md] file for more details.
  30
  31 [CONTRIBUTING.md]: https://github.com/rust-lang/rust-by-example/blob/master/CONTRIBUTING.md
  32
  33 ## Translations to other languages
  34
  35 * [Chinese](https://github.com/rust-lang-cn/rust-by-example-cn)
  36 * [Japanese](https://github.com/rust-lang-ja/rust-by-example-ja)
  37
  38 ## License
  39
  40 Rust by Example is licensed under either of
  41
  42  * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
  43    http://www.apache.org/licenses/LICENSE-2.0)
  44  * MIT license ([LICENSE-MIT](LICENSE-MIT) or
  45    http://opensource.org/licenses/MIT)
  46
  47 at your option.
  48
  49 Unless you explicitly state otherwise, any contribution intentionally submitted
  50 for inclusion in Rust by Example by you, as defined in the Apache-2.0 license, shall be
  51 dual licensed as above, without any additional terms or conditions.