2015-08-30 22:06:10 +00:00
|
|
|
# Rust Design Patterns
|
|
|
|
|
|
2021-01-02 11:15:33 +00:00
|
|
|
An open source book about design patterns and idioms in the Rust programming
|
|
|
|
|
language that you can read [here](https://rust-unofficial.github.io/patterns/).
|
2015-08-30 22:06:10 +00:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2021-01-21 23:00:02 +00:00
|
|
|
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.
|
2015-10-15 02:12:37 +00:00
|
|
|
|
2021-01-21 23:00:02 +00:00
|
|
|
You can check the [Umbrella issue](https://github.com/rust-unofficial/patterns/issues/116)
|
|
|
|
|
for all the patterns, anti-patterns, and idioms that could be added.
|
2021-01-06 12:55:05 +00:00
|
|
|
|
2021-01-21 23:00:02 +00:00
|
|
|
We suggest reading our [Contribution guide](./CONTRIBUTING.md) to get more information
|
|
|
|
|
on how contributing to this repository works.
|
2016-09-28 22:39:56 +00:00
|
|
|
|
2021-01-01 11:27:42 +00:00
|
|
|
## Building with mdbook
|
|
|
|
|
|
2021-01-21 23:00:02 +00:00
|
|
|
This book is built with [mdbook](https://rust-lang.github.io/mdBook/). You can
|
|
|
|
|
install it by running `cargo install mdbook`.
|
2021-01-01 11:27:42 +00:00
|
|
|
|
2021-01-21 23:00:02 +00:00
|
|
|
If you want to build it locally you can run one of these two commands in the root
|
|
|
|
|
directory of the repository:
|
2021-01-01 11:27:42 +00:00
|
|
|
|
|
|
|
|
- `mdbook build`
|
|
|
|
|
|
2021-01-21 23:00:02 +00:00
|
|
|
Builds static html pages as output and place them in the `/book` directory by
|
|
|
|
|
default.
|
2021-01-01 11:27:42 +00:00
|
|
|
|
|
|
|
|
- `mdbook serve`
|
|
|
|
|
|
2021-01-21 23:00:02 +00:00
|
|
|
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.
|
2021-01-02 11:58:40 +00:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2021-07-23 19:17:11 +00:00
|
|
|
The content of this repository is licensed under **MPL-2.0**; see [LICENSE](./LICENSE).
|
