rust-unofficial / patterns

A catalogue of Rust design patterns, anti-patterns and idioms
https://rust-unofficial.github.io/patterns/
Mozilla Public License 2.0
7.95k stars 362 forks source link

Idea: CLI tool for using rust-patterns as a manual #170

Closed simonsan closed 3 years ago

simonsan commented 3 years ago

Something for the really far future:

Build a tool that pulls in this repository and wraps it man-like, so people could actually search within these articles from the command line.

MarcoIeni commented 3 years ago

Basically it could be a way to read mdbooks interactively in the terminal, right? I don't think the binary should be called rust-patterns. You install this general binary, that could be used for any book. So it should be like cargo install mdb-reader or something like that.

simonsan commented 3 years ago

Updated the initial comment :-) Used the name because of this repository, but you're right in that it makes sense to chose a general name from the beginning to not let people get confused over this.

pickfire commented 3 years ago

Something like https://crates.io/crates/rusty-man? Or maybe we can open this in mdbook as an issue?