Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rust-lang/rust-by-example
Learn Rust with examples (Live code editor included)
https://github.com/rust-lang/rust-by-example
Last synced: about 2 months ago
JSON representation
Learn Rust with examples (Live code editor included)
- Host: GitHub
- URL: https://github.com/rust-lang/rust-by-example
- Owner: rust-lang
- License: apache-2.0
- Created: 2014-04-24T22:22:40.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-26T20:48:28.000Z (about 2 months ago)
- Last Synced: 2024-07-26T22:24:52.527Z (about 2 months ago)
- Language: Handlebars
- Homepage: https://doc.rust-lang.org/stable/rust-by-example/
- Size: 5.52 MB
- Stars: 6,904
- Watchers: 152
- Forks: 1,331
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- my-awesome-github-stars - rust-lang/rust-by-example - Learn Rust with examples (Live code editor included) (Handlebars)
- awesome-by-example - Rust by Example: Learn Rust with examples (Live code editor included)
- stars - rust-lang/rust-by-example - Learn Rust with examples (Live code editor included) (Handlebars)
- awesome-list - rust-by-example - lang | 4047 | (Others)
- StarryDivineSky - rust-lang/rust-by-example
README
# 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
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!
**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:
```bash
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.
[CONTRIBUTING.md]: https://github.com/rust-lang/rust-by-example/blob/master/CONTRIBUTING.md
## Translating
Please see the [TRANSLATING.md] file for more details.
[TRANSLATING.md]: https://github.com/rust-lang/rust-by-example/blob/master/TRANSLATING.md
### Translating guide for each languages
* Japanese/日本語: [TRANSLATING_JA.md]
[TRANSLATING_JA.md]: https://github.com/rust-lang/rust-by-example/blob/master/TRANSLATING_JA.md
## Translations to other languages
* [Bulgarian](https://github.com/kberov/rust-by-example-bg)
* [Chinese](https://github.com/rust-lang-cn/rust-by-example-cn)
* [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)
* [Portuguese](https://github.com/nazarepiedady/rust-com-exemplos)
## License
Rust by Example is licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
)
* MIT license ([LICENSE-MIT](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.