Archives/patterns
2
1
Fork 0
mirror of https://github.com/rust-unofficial/patterns synced 2024-11-18 15:25:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
b714ff5ffb
patterns/README.md
simonsan d96de404c4
feat(pdf): add pdf download (#399) 
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
2024-03-17 03:35:42 +01:00

1.5 KiB
Raw Blame History

Rust Design Patterns

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

You can also download the book in PDF format from this link.

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

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