An open API service indexing awesome lists of open source software.

https://github.com/john-cd/rust_howto

John's Rust How-To Book
https://github.com/john-cd/rust_howto

book cookbook how-to howto mdbook rust rust-cheat rust-cheats rust-lang

Last synced: 6 months ago
JSON representation

John's Rust How-To Book

Awesome Lists containing this project

README

          

# The Rust How-To Book

[![Build and deploy (Linux)](https://github.com/john-cd/rust_howto/actions/workflows/build_deploy_book.yml/badge.svg)](https://github.com/john-cd/rust_howto/actions/workflows/build_deploy_book.yml)[![(Windows)](https://github.com/john-cd/rust_howto/actions/workflows/build_book_code_and_book_on_windows.yml/badge.svg)](https://github.com/john-cd/rust_howto/actions/workflows/build_book_code_and_book_on_windows.yml)

**A documentation summary and a compendium of recipes for the Rust language and ecosystem.**
**Everything you need for day-to-day Rust coding, all in one place.**

Point your browser to [`https://john-cd.com/rust_howto`][rust-howto-website]⮳ to read the [Rust How-to][rust-howto-website]⮳ book.

## Work In Progress

This book is still going through _heavy edits_. Pardon the dust.

## Contributing

Contributions are most welcome!

Please review the [contributing][rust-howto-contributing-website]⮳ section of the book and peruse the book's [GitHub repo][rust-howto-github]⮳.

## Companion Tool

The [mdbook-utils][c-mdbook-utils-crates.io] utility ([(github)][c-mdbook-utils-github] [(docs.rs)][c-mdbook-utils-docs-rs] [(user guide)][c-mdbook-utils-user-guide]) helps manage links and code blocks in [`mdbook`][c-mdbook] source directories. It is the companion tool for this book.

## Acknowledgments

This book is written and edited by [John CD][john-cd]⮳. It is the successor of and incorporates most of the [Rust Cookbook][rust-cookbook-website]⮳. Thanks to its many [contributors][rust-cookbook-contributors-website]⮳.

## Legal

Please refer to the LICENSE files. All code examples included in or linked from the book, under the `bk/crates` and `xmpl` folders, are licensed under the Creative Commons Zero v1.0 Universal License [LICENSE-CC0][CC0]⮳. All other software (e.g. under the `tools` folder) is licensed under either of the Apache License Version 2.0 or the MIT license at your option, per the Rust community custom.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this repository by you, as defined in the license, shall be licensed as above, without any additional terms or conditions.

This site is not affiliated with the [Rust Foundation][rust-foundation-website]⮳.

[CC0]: https://creativecommons.org/publicdomain/zero/1.0/legalcode
[c-mdbook]: https://rust-lang.github.io/mdBook
[c-mdbook-utils-github]: https://github.com/john-cd/mdbook-utils
[c-mdbook-utils-docs-rs]: https://docs.rs/mdbook-utils/latest/mdbook_utils
[c-mdbook-utils-crates.io]: https://crates.io/crates/mdbook-utils
[c-mdbook-utils-user-guide]: https://john-cd.github.io/mdbook-utils
[john-cd]: https://github.com/john-cd
[rust-cookbook-website]:
[rust-cookbook-contributors-website]: https://github.com/rust-lang-nursery/rust-cookbook/graphs/contributors
[rust-foundation-website]: https://foundation.rust-lang.org
[rust-howto-website]: https://john-cd.com/rust_howto
[rust-howto-contributing-website]: https://john-cd.com/rust_howto/contributing/index.html
[rust-howto-github]: https://github.com/john-cd/rust_howto