Skip to content

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

Closed

Description

@simonsan

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.

  • distributable via crate.io
  • cargo install mdb-reader to install, cargo install-update mdb-reader to update
  • you can use the tool to search for patterns on the commandline working like man on Linux
  • mdb-reader rust-patterns builder prints the builder pattern article in a nice commandline-native way
  • nice to read something while developing in IDE
  • could be used for other mdbooks as well, if there are multiple sources to pull data from, but would be the same basis

Activity

  1. added
    C-needs discussionArea: Something that is not clear to everyone if it fixes something/adds valuable content
    on Jan 5, 2021
  2. marcoieni commented on Jan 5, 2021

    @marcoieni
    Collaborator

    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.

  3. simonsan commented on Jan 6, 2021

    @simonsan
    CollaboratorAuthor

    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.

  4. pickfire commented on Jan 11, 2021

    @pickfire
    Contributor

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

  5. added
    C-upstreamCategory: Issue for a dependency, will be fixed upstream
    on Jan 11, 2021
  6. added
    M-move-to-discussionsMeta: Label for converting issues to discussions
    and removed
    C-needs discussionArea: Something that is not clear to everyone if it fixes something/adds valuable content
    C-out of scopeCategory: Currently out-of-scope
    C-upstreamCategory: Issue for a dependency, will be fixed upstream
    on Feb 22, 2021
  7. locked and limited conversation to collaborators on Feb 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    M-move-to-discussionsMeta: Label for converting issues to discussions

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions