Go to file
2021-03-08 16:06:44 +01:00
.github/workflows CI: Rename markdownlint job (#180) 2021-01-06 15:08:04 +01:00
additional_resources Shorten lines to line-length 80 (#208) 2021-01-22 00:00:02 +01:00
anti_patterns Add link to a list of all clippy lints (#216) 2021-02-02 20:56:01 +01:00
functional Shorten lines to line-length 80 (#208) 2021-01-22 00:00:02 +01:00
idioms Improve wording and fix typo (#242) 2021-02-28 23:46:55 +01:00
patterns Fix format by moving advantage to new bullet (#245) 2021-03-08 16:06:44 +01:00
refactoring Shorten lines to line-length 80 (#208) 2021-01-22 00:00:02 +01:00
.env Updating mdbook version (#243) 2021-03-02 22:11:50 +01:00
.gitignore Adding Strategy pattern (#146) 2021-01-12 01:04:25 +01:00
.markdownlint.yaml Shorten lines to line-length 80 (#208) 2021-01-22 00:00:02 +01:00
book.toml Adding mdbook configuration and deployment to gh-pages (#111) 2021-01-01 12:27:42 +01:00
CONTRIBUTING.md Shorten lines to line-length 80 (#208) 2021-01-22 00:00:02 +01:00
intro.md Shorten lines to line-length 80 (#208) 2021-01-22 00:00:02 +01:00
LICENSE Initial commit 2015-08-31 10:06:10 +12:00
README.md Shorten lines to line-length 80 (#208) 2021-01-22 00:00:02 +01:00
SUMMARY.md Structural changes to patterns subfolder (#219) 2021-02-25 20:56:37 +01:00
template.md Apply markdownlint to project (#163) 2021-01-05 15:36:20 +01:00

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.