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

Include help output in Readme #412

Open
corneliusroemer opened this issue Sep 25, 2024 · 0 comments
Open

Include help output in Readme #412

corneliusroemer opened this issue Sep 25, 2024 · 0 comments

Comments

@corneliusroemer
Copy link
Contributor

Muffet currently doesn't seem to have dedicated docs. The readme points at --help output.

It would be great to include the help output in the Readme to make it easier to have a quick reference available.

Even better would be to auto generate the help output and put it in an automaintained file in the repo that could be linked to.

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