rust-cookbook/README.md

# A Rust Cookbook &emsp; [![Build Status travis]][travis]

[Build Status travis]: https://api.travis-ci.com/rust-lang-nursery/rust-cookbook.svg?branch=master
[travis]: https://travis-ci.com/rust-lang-nursery/rust-cookbook

**[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:

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

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

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

[Read it here]: https://rust-lang-nursery.github.io/rust-cookbook
[Rust]: https://www.rust-lang.org/

## 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.

[CONTRIBUTING.md]: https://github.com/rust-lang-nursery/rust-cookbook/blob/master/CONTRIBUTING.md

## License [![CC0-badge]][CC0-deed]

Rust Cookbook is licensed under Creative Commons Zero v1.0 Universal License
([LICENSE-CC0](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][CC0-deed] and licensed as above, without any additional
terms or conditions.

[CC0-deed]: https://creativecommons.org/publicdomain/zero/1.0/deed.en
[CC0-badge]: https://mirrors.creativecommons.org/presskit/buttons/80x15/svg/cc-zero.svg
remove badge artifacts 2019-12-17 04:14:06 +00:00			`# A Rust Cookbook &emsp; [![Build Status travis]][travis]`
Add CI badge to readme 2017-05-18 00:08:38 +00:00
Update Travis CI URL (#545) 2019-09-19 18:54:33 +00:00			`[Build Status travis]: https://api.travis-ci.com/rust-lang-nursery/rust-cookbook.svg?branch=master`
			`[travis]: https://travis-ci.com/rust-lang-nursery/rust-cookbook`
. 2017-02-21 22:41:35 +00:00
More stuff 2017-04-30 06:24:42 +00:00			`[Read it here].`
. 2017-02-21 22:41:35 +00:00
Removed Rust install link; added Rust general link; fixed per-browser instructions 2017-12-28 14:26:50 +00:00			`This _Rust Cookbook_ is a collection of simple [Rust] examples that`
More stuff 2017-04-30 06:24:42 +00:00			`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.`

Removed Rust install link; added Rust general link; fixed per-browser instructions 2017-12-28 14:26:50 +00:00			`## Read it offline`

			`If you'd like to read it locally:`
Added local mdbook instructions to README.md 2017-12-27 19:10:11 +00:00
			```bash
			`$ git clone https://github.com/rust-lang-nursery/rust-cookbook`
			`$ cd rust-cookbook`
Update to edition 2018 (#565) * Update to edition 2018 Update mdbook to 0.3.5 Command: sed -i '/extern crate/ {N;s/\n$//}' src/.md; sed -i 's/extern crate error_chain;/use error_chain::error_chain;/; s/extern crate lazy_static;/use lazy_static::lazy_static;/; s/extern crate bitflags;/use bitflags::bitflags;/; s/extern crate serde_json;/ use serde_json::json;/; s/extern crate serde_derive;/use serde::{Serialize, Deserialize};/; /macro_use/d; /extern crate/ d; s/```rust/```rust,edition2018/; s/bail!/error_chain::&/; s/\(debug\\|info\\|warn\\|error\)!/log::&/;' src/.md Fix #530 * Update rand-dist.md * Fixes #569 * dump syslog version 4 depends on error-chain v 0.11 and version 5 depends on v 0.12 !!!! Co-authored-by: Andrew Gauger <andygauge@gmail.com> 2020-06-01 00:26:32 +00:00			`$ cargo install mdbook --vers "0.3.5"`
Replaced mdbook build with mdbook server --open 2017-12-28 17:33:43 +00:00			`$ mdbook serve --open`
Added local mdbook instructions to README.md 2017-12-27 19:10:11 +00:00			```

Simplified web launch 2017-12-28 16:49:36 +00:00			The output can also be opened from the `book` subdirectory in your web browser.
Removed Rust install link; added Rust general link; fixed per-browser instructions 2017-12-28 14:26:50 +00:00
			```bash
Simplified web launch 2017-12-28 16:49:36 +00:00			`$ xdg-open ./book/index.html # linux`
			`$ start .\book\index.html # windows`
			`$ open ./book/index.html # mac`
Removed Rust install link; added Rust general link; fixed per-browser instructions 2017-12-28 14:26:50 +00:00			```

fixed links and CI auto-deploy after move to rust-lang-nursery - fixed stargazers example broken due to repo move - fixed edit functionality broken due to repo move 2017-07-29 16:29:41 +00:00			`[Read it here]: https://rust-lang-nursery.github.io/rust-cookbook`
Removed Rust install link; added Rust general link; fixed per-browser instructions 2017-12-28 14:26:50 +00:00			`[Rust]: https://www.rust-lang.org/`
. 2017-02-21 22:41:35 +00:00
Add contribution guide skeleton 2017-02-25 08:25:51 +00:00			`## Contributing`
. 2017-02-21 22:41:35 +00:00
Removed Rust install link; added Rust general link; fixed per-browser instructions 2017-12-28 14:26:50 +00:00			`This project is intended to be easy for new [Rust] programmers to`
readme: de-swap 2017-07-21 00:38:24 +00:00			`contribute to, and an easy way to get involved with the Rust`
More stuff 2017-04-30 06:24:42 +00:00			`community. It needs and welcomes help.`
. 2017-02-21 22:41:35 +00:00
More stuff 2017-04-30 06:24:42 +00:00			`For details see [CONTRIBUTING.md] on GitHub.`
. 2017-02-21 22:41:35 +00:00
fixed links and CI auto-deploy after move to rust-lang-nursery - fixed stargazers example broken due to repo move - fixed edit functionality broken due to repo move 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
Changed license to CC0 https://creativecommons.org/publicdomain/zero/1.0/ (#210) 2018-04-25 22:28:21 +00:00			`## License [![CC0-badge]][CC0-deed]`
More stuff 2017-04-30 06:24:42 +00:00
Changed license to CC0 https://creativecommons.org/publicdomain/zero/1.0/ (#210) 2018-04-25 22:28:21 +00:00			`Rust Cookbook is licensed under Creative Commons Zero v1.0 Universal License`
			`([LICENSE-CC0](LICENSE-CC0) or https://creativecommons.org/publicdomain/zero/1.0/legalcode)`
Added clarification of licensing Rust Cookbook is licensed under dual MIT/Apache-2.0 license. 2017-06-13 21:19:28 +00:00
			`Unless you explicitly state otherwise, any contribution intentionally submitted`
Changed license to CC0 https://creativecommons.org/publicdomain/zero/1.0/ (#210) 2018-04-25 22:28:21 +00:00			`for inclusion in Rust Cookbook by you, as defined in the CC0-1.0 license, shall be`
			`[dedicated to the public domain][CC0-deed] and licensed as above, without any additional`
			`terms or conditions.`

			`[CC0-deed]: https://creativecommons.org/publicdomain/zero/1.0/deed.en`
			`[CC0-badge]: https://mirrors.creativecommons.org/presskit/buttons/80x15/svg/cc-zero.svg`