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

Readme Format With Clap #10

Open
AljoschaMeyer opened this issue Nov 20, 2022 · 2 comments
Open

Readme Format With Clap #10

AljoschaMeyer opened this issue Nov 20, 2022 · 2 comments

Comments

@AljoschaMeyer
Copy link
Collaborator

Do you want to keep the short and informal list of modules, or should we switch to listing modules together with their module --help output after switching everything to using clap?

@sandreae
Copy link
Owner

Some context for my answer: one hope I have for this project is to do gigs with medium sized groups of performers, not limited to people with programming experience.

With that in mind, I'd like there to be a place where the modules are described using non-specialised language (with a focus on the audible result) and with very simple use instructions. I realise while this repo is acting as the sole source of all earwig info we may be fighting contradictory goals (dev friendly docs vs. user friendly docs) but maybe there is a path for now where we don't end up with too much duplication.

Having a consistent layout (as clap docs gives us) is great though, how about:

  • We switch to clap style docs as you drafted
  • We keep in mind that the module descriptions should try to use non-specialist language (maybe it can even be engaging ;-p)
  • Any deeper descriptions of how the module works can go in the module itself

@AljoschaMeyer
Copy link
Collaborator Author

Sounds good to me. Also, keep in mind that my investment in this project is realistically speaking far lower than yours, so I wouldn't mind at all if you simply overruled me on issues like this.

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

2 participants