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.

Sign up for GitHub

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

Jump to bottom

What should go in the readme? #3

Open
ansuz opened this issue Mar 13, 2016 · 1 comment
Open

What should go in the readme? #3

ansuz opened this issue Mar 13, 2016 · 1 comment

Comments

@ansuz
Copy link
Member

ansuz commented Mar 13, 2016

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
@ansuz
Copy link
Member Author

ansuz commented Mar 13, 2016

With regards to Policy && License, we're definitely going to need to address NSFW content and other questionable materials in advance. If something is a problem I would like to be able to remove it without having to form a committee.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ansuz