You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
simonsan f61f2f40f0
Fix lines to 150 line length for better tracking of future changes (#189)
3 years ago
.github/workflows CI: Rename markdownlint job (#180) 3 years ago
additional_resources Fix lines to 150 line length for better tracking of future changes (#189) 3 years ago
anti_patterns Fix lines to 150 line length for better tracking of future changes (#189) 3 years ago
functional Fix lines to 150 line length for better tracking of future changes (#189) 3 years ago
idioms Fix lines to 150 line length for better tracking of future changes (#189) 3 years ago
patterns Fix lines to 150 line length for better tracking of future changes (#189) 3 years ago
refactoring Fix lines to 150 line length for better tracking of future changes (#189) 3 years ago
.env Updating mdbook (#162) 3 years ago
.gitignore Adding mdbook configuration and deployment to gh-pages (#111) 4 years ago
.markdownlint.yaml Fix lines to 150 line length for better tracking of future changes (#189) 3 years ago
CONTRIBUTING.md Fix lines to 150 line length for better tracking of future changes (#189) 3 years ago
LICENSE Initial commit 9 years ago
README.md Fix lines to 150 line length for better tracking of future changes (#189) 3 years ago
SUMMARY.md Remove contributing from html rendered book (#187) 3 years ago
book.toml Adding mdbook configuration and deployment to gh-pages (#111) 4 years ago
intro.md intro.md: split lines (#188) 3 years ago
template.md Apply markdownlint to project (#163) 3 years ago

README.md

Rust Design Patterns

An open source book about design patterns and idioms in the Rust programming language that you can read here.

Contributing

You are missing content in this repository that can be helpful for others and you are eager to explain it? Awesome! We are always happy about new contributions (e.g. elaboration or corrections on certain topics) to this project.

You can check the Umbrella issue for all the patterns, anti-patterns, and idioms that could be added.

We suggest reading our Contribution guide to get more information on how contributing to this repository works.

Building with mdbook

This book is built with mdbook. You can install it by running cargo install mdbook.

If you want to build it locally you can run one of these two commands in the root directory of the repository:

  • mdbook build

    Builds static html pages as output and place them in the /book directory by default.

  • mdbook serve

    Serves the book at http://localhost:3000 (port is changeable, take a look at the terminal output to be sure) and reloads the browser when a change occurs.

License

This content of this repository is licensed under MPL-2.0; see LICENSE.