Skip to content

Readme - what is it? #11

@bish0polis

Description

@bish0polis

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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions