No description
Find a file
Michał Budzyński 0c167cb32c support for additional linters (link-checker & aspell) (#410)
* Added support for additional linters (html-proofer link checker)

- added additional test matrix item just for linters
- install and build mdbook only when needed to speedup CI
- reorganized the travis scripts

* Added spellchecking script from rust-book to CI

also fixed minor typos

* updated and moved serde_json links to propper position

* move link checking to link-checker
2018-06-06 08:33:25 -07:00
.github Update github pull request template after CC0 licensing change 2018-04-26 07:17:38 +02:00
assets Added assets folder for images 2017-02-26 10:21:43 -06:00
ci support for additional linters (link-checker & aspell) (#410) 2018-06-06 08:33:25 -07:00
src support for additional linters (link-checker & aspell) (#410) 2018-06-06 08:33:25 -07:00
tests Initial 2017-02-20 11:22:19 -08:00
theme support search by updating to mdbook 0.1.7 2018-05-16 22:40:39 +02:00
.gitignore Git ignore Cargo.lock 2017-05-23 12:33:40 -07:00
.travis.yml support for additional linters (link-checker & aspell) (#410) 2018-06-06 08:33:25 -07:00
appveyor.yml Removed appveyor cache as it caused spurious build fails 2017-09-24 10:17:38 +02:00
book.toml support search by updating to mdbook 0.1.7 2018-05-16 22:40:39 +02:00
build.rs Various restructuring 2017-04-29 23:21:34 -07:00
Cargo.toml fix rand crate example and broken links 2018-06-04 12:58:13 +02:00
CONTRIBUTING.md fix rand crate example and broken links 2018-06-04 12:58:13 +02:00
LICENSE-CC0 Changed license to CC0 https://creativecommons.org/publicdomain/zero/1.0/ (#210) 2018-04-25 15:28:21 -07:00
README.md support search by updating to mdbook 0.1.7 2018-05-16 22:40:39 +02:00

A Rust Cookbook Build Status travis Build Status appveyor

Read it here.

This Rust Cookbook is a collection of simple Rust 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.

Read it offline

If you'd like to read it locally:

$ git clone https://github.com/rust-lang-nursery/rust-cookbook
$ cd rust-cookbook
$ cargo install mdbook --vers "0.1.7"
$ mdbook serve --open

The output can also be opened from the book subdirectory in your web browser.

$ xdg-open ./book/index.html # linux
$ start .\book\index.html    # windows
$ open ./book/index.html     # mac

Contributing

This project is intended to be easy for new Rust programmers to contribute to, and an easy way to get involved with the Rust community. It needs and welcomes help.

For details see CONTRIBUTING.md on GitHub.

License CC0-badge

Rust Cookbook is licensed under Creative Commons Zero v1.0 Universal License (LICENSE-CC0 or https://creativecommons.org/publicdomain/zero/1.0/legalcode)

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Rust Cookbook by you, as defined in the CC0-1.0 license, shall be dedicated to the public domain and licensed as above, without any additional terms or conditions.