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

better usage in readme and --help, maybe a manpage #16

Open
Baerbeisser opened this issue Jun 3, 2024 · 0 comments
Open

better usage in readme and --help, maybe a manpage #16

Baerbeisser opened this issue Jun 3, 2024 · 0 comments

Comments

@Baerbeisser
Copy link

Baerbeisser commented Jun 3, 2024

Assuming i'm not a user of linguist tool, only way to figure out usage i found is --help

  enry v2.1.0 build: 08-07-2019_17_39_18 commit: 3c3ea9a, based on linguist commit: 3a1bd3c
  enry, A simple (and faster) implementation of github/linguist
  usage: enry [-mode=(file|line|byte)] [-prog] <path>
         enry [-mode=(file|line|byte)] [-prog] [-json] [-breakdown] <path>
         enry [-mode=(file|line|byte)] [-prog] [-json] [-breakdown]
         enry [-version]

which is good enough for a short overview, which --help is for. But things missing are:

  • -all option mentioned in README.md
  • Explanation of each option (what it is for)
  • usage of each option, such as
    ** explanation of file|line|byte
    ** do --json/--breakdown mentioned in README.md need a filename/full path to write to?
    ** used files/environment variables

btw, is it --json/--breakdown as in README.md or -json/-breakdown as reported by --help? And for the other options, - or --?

I mean, i know writing documentation can be a pain, but this is a bit too meager.

@Baerbeisser Baerbeisser changed the title better usage in reamde and --help, maybe a manpage better usage in readme and --help, maybe a manpage Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant