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

Improve readme #46

Open
dareid opened this issue Jun 8, 2018 · 1 comment
Open

Improve readme #46

dareid opened this issue Jun 8, 2018 · 1 comment

Comments

@dareid
Copy link
Member

dareid commented Jun 8, 2018

  • Remove godoc badge
  • Show output
  • Show local + docker usage together
  • Fix local install instructions (go install)
  • Add contributing section
  • Install before usage?
  • Explain docker volume
  • Exit code 0 and stderr+stdout behaviour
  • Ordering
  • Show help output? or include details of output formats

Others from https://gist.github.com/alcortesm/f45a5f6b5e1543be3f1f88dde43cdecd

Thanks @rossmcf and @alcortesm

@akavel
Copy link

akavel commented Nov 16, 2018

Please also do explain what algorithm(s) are used for searching and identifying the licenses. It's quite important when evaluating various "license detectors", as licenses can be hidden in a lots of non-standard places, such as file headers, etc; also subdirectories can have different licenses, also I'd like to know if the tool detects non-standard licenses (e.g. commercial ones) to warn me about them, etc, etc. Otherwise it's "the tool detected something, but I don't know if/to what extent I can rely on that". For example, go-license-detector has a rather nice explanation in the readme, from which I can see that it seems to only focus on LICENSE file, ignoring any subdirectories IIUC. This clearly communicates to me its features and its limitations.

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

No branches or pull requests

2 participants