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 - what is it? #11

Open
bish0polis opened this issue May 29, 2017 · 0 comments
Open

Readme - what is it? #11

bish0polis opened this issue May 29, 2017 · 0 comments

Comments

@bish0polis
Copy link

The readme fails to answer the most basic question: what is it?

It's a common problem with README files, in that no one assumes people would go to a web site without already knowing what's there. In my case, for instance, I came here after seeing the tool referenced in another page and I came to answer the question "Why am I installing this, and what does it do for me?", which may be a valid question. Please consider adding the smallest of paragraphs to the readme so drive-bys have an exec summary.

Thanks!

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