Repository files navigation

Read it here.

ThisRust Cookbook is a collection of simpleRust examples thatdemonstrate good practices to accomplish common programming tasks,using the crates of the Rust ecosystem.

These examples are complete, and suitable for copying directly intonew cargo projects. They are tested and guaranteed to work.

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.4.43"$ mdbook serve --open

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

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

For local development and testing, you can use the provided Makefile:

# Show all available commandsmakehelp# Build the book locallymake build# Run testsmaketest# Build and test (development workflow)make dev# Serve the book locally with live reloadmake serve# Clean build artifactsmake clean

As a maintainer, you can deploy the site locally using:

# Deploy to GitHub Pages (requires maintainer permissions)make deploy# Or use the script directly./scripts/deploy.sh

The deployment script will:

1. Build and test the book
2. Push the built site to thegh-pages branch
3. GitHub Pages will automatically serve the updated site

Note: This requires maintainer permissions to push to thegh-pages branch.

This project is intended to be easy for newRust programmers tocontribute to, and an easy way to get involved with the Rustcommunity. It needs and welcomes help.

For details seeCONTRIBUTING.md on GitHub.

Rust Cookbook is licensed under Creative Commons Zero v1.0 Universal License(LICENSE-CC0 orhttps://creativecommons.org/)

Unless you explicitly state otherwise, any contribution intentionally submittedfor inclusion in Rust Cookbook by you, as defined in the CC0-1.0 license, shall bededicated to the public domain and licensed as above, without any additionalterms or conditions.