Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: output binaries' --help into template #58

Open
clbarnes opened this issue Nov 28, 2020 · 0 comments
Open

Feature request: output binaries' --help into template #58

clbarnes opened this issue Nov 28, 2020 · 0 comments

Comments

@clbarnes
Copy link

Keeping a binary crate's usage information up to date with the crate itself is really helpful. I made a very hacky python tool for piping text into markdown code blocks for this purpose, so my README would look like

# My package

## Usage

```_mybinary
```

Then do cargo run -- --help | pipe2codeblock --tgt _mybinary README.md to dump the help text into that labelled code block, and git diff --exit-code in CI to make sure every commit has it up to date.

I'd love to replace that with a template with cargo-readme: do you think that would be helpful?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant