Skip to content

What should go in the readme? #3

@ansuz

Description

@ansuz

The readme should be as brief as possible, but give a complete list of the features of the repo in short sections.

  • About
    • reasons for this repo
  • Howto
    • link to resources for setting up your first service on Hyperboria (these could be internal)
  • Policy
    • what you must do to get listed in this repository
  • Asking questions
    • where to go, who to contact, etc.
  • License
    • If we need this. I am not a lawyer

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