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

Look into upgrading README and/or using Description of a Project schema #1250

Closed
ctb opened this issue Aug 13, 2015 · 4 comments
Closed

Look into upgrading README and/or using Description of a Project schema #1250

ctb opened this issue Aug 13, 2015 · 4 comments
Labels
Documentation
Milestone
2.1

Comments

@ctb
Copy link
Member

ctb commented Aug 13, 2015

See conversation at https://twitter.com/mkramer/status/631559419168489472. @melodykramer suggests:

  1. In plain language, what is this project and what does it do?
  2. Who made this project?
  3. Who is the audience for this project?
  4. How do I set this project up on my own machine?
  5. How do I test this project to make sure it works?
  6. Who has adapted this project and can I see screenshots or examples?
  7. Who do I contact if I need help with this project?
  8. What languages is this project in?
  9. If I wanted to help with this project, what is the best way to do that?
  10. Is the project in active development?
  11. What is the licensing on this project?

and then julianhyde suggested looking at "Description of a Project", https://en.wikipedia.org/wiki/DOAP
@mr-c
Copy link
Contributor

mr-c commented Aug 13, 2015

FYI, our PyPI page gets us DOAP for free. We could also ship it directly.

@mr-c mr-c added this to the 2.0+ milestone Aug 13, 2015
@melodykramer
Copy link

This discussion might also be of interest: 18F/open-source-guide#15 (comment)

@mr-c
Copy link
Contributor

mr-c commented Aug 18, 2015

Thank you @melodykramer for linking to that conversation

@standage standage modified the milestones: 2.1, 2.0+ Jun 27, 2016
@standage standage mentioned this issue Feb 24, 2017
Merged
3 tasks
standage added a commit that referenced this issue Feb 24, 2017
@standage
Some improvements inspired by #1250.
cd0e746
@betatim
Copy link
Member

betatim commented Feb 27, 2017

Closed via #1644

@betatim betatim closed this as completed Feb 27, 2017
Dmarch28 pushed a commit to Dmarch28/khmer that referenced this issue Mar 10, 2021
@standage @Dmarch28
Some improvements inspired by dib-lab#1250.
925e375
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
2.1
Development

No branches or pull requests
5 participants
@ctb @standage @mr-c @betatim @melodykramer