2017-08-23 04:47:13 +00:00
|
|
|
# A Rust Cookbook   [![Build Status travis]][travis] [![Build Status appveyor]][appveyor]
|
2017-05-18 00:08:38 +00:00
|
|
|
|
2017-08-23 04:47:13 +00:00
|
|
|
[Build Status travis]: https://api.travis-ci.org/rust-lang-nursery/rust-cookbook.svg?branch=master
|
2017-07-29 16:29:41 +00:00
|
|
|
[travis]: https://travis-ci.org/rust-lang-nursery/rust-cookbook
|
2017-08-23 04:47:13 +00:00
|
|
|
[Build Status appveyor]: https://ci.appveyor.com/api/projects/status/k56hklb7puv7c4he?svg=true
|
|
|
|
[appveyor]: https://ci.appveyor.com/project/rust-lang-libs/rust-cookbook
|
2017-02-21 22:41:35 +00:00
|
|
|
|
2017-04-30 06:24:42 +00:00
|
|
|
**[Read it here]**.
|
2017-02-21 22:41:35 +00:00
|
|
|
|
2017-04-30 06:24:42 +00:00
|
|
|
This _Rust Cookbook_ is a collection of simple examples that
|
|
|
|
demonstrate good practices to accomplish common programming tasks,
|
|
|
|
using the crates of the Rust ecosystem.
|
|
|
|
|
|
|
|
These examples are complete, and suitable for copying directly into
|
|
|
|
new cargo projects. They are tested and guaranteed to work.
|
|
|
|
|
2017-12-27 19:10:11 +00:00
|
|
|
If you'd like to read it locally, [install Rust], and then:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ git clone https://github.com/rust-lang-nursery/rust-cookbook
|
|
|
|
$ cd rust-cookbook
|
|
|
|
$ cargo install mdbook
|
|
|
|
$ mdbook build
|
|
|
|
$ mdbook serve
|
|
|
|
```
|
|
|
|
|
2017-07-29 16:29:41 +00:00
|
|
|
[Read it here]: https://rust-lang-nursery.github.io/rust-cookbook
|
2017-12-27 19:10:11 +00:00
|
|
|
[install Rust]: https://www.rustup.rs
|
2017-02-21 22:41:35 +00:00
|
|
|
|
2017-02-25 08:25:51 +00:00
|
|
|
## Contributing
|
2017-02-21 22:41:35 +00:00
|
|
|
|
2017-05-13 09:10:23 +00:00
|
|
|
This project is intended to be easy for new Rust programmers to
|
2017-07-21 00:38:24 +00:00
|
|
|
contribute to, and an easy way to get involved with the Rust
|
2017-04-30 06:24:42 +00:00
|
|
|
community. It needs and welcomes help.
|
2017-02-21 22:41:35 +00:00
|
|
|
|
2017-04-30 06:24:42 +00:00
|
|
|
For details see [CONTRIBUTING.md] on GitHub.
|
2017-02-21 22:41:35 +00:00
|
|
|
|
2017-07-29 16:29:41 +00:00
|
|
|
[CONTRIBUTING.md]: https://github.com/rust-lang-nursery/rust-cookbook/blob/master/CONTRIBUTING.md
|
2017-02-21 22:41:35 +00:00
|
|
|
|
2017-04-30 06:24:42 +00:00
|
|
|
## License
|
|
|
|
|
2017-06-13 21:19:28 +00:00
|
|
|
Rust Cookbook 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 Cookbook by you, as defined in the Apache-2.0 license, shall be
|
|
|
|
dual licensed as above, without any additional terms or conditions.
|