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

documentation style readme #49

Open
Pomax opened this issue Sep 8, 2016 · 0 comments
Open

documentation style readme #49

Pomax opened this issue Sep 8, 2016 · 0 comments

Comments

@Pomax
Copy link

Pomax commented Sep 8, 2016

we don't have any helpful guidelines on how to write a good README, it might be worth "documenting how to document" in terms of which sections should be in a README and what level of details those sections should go into.

Based on our work so far, we usually cover the following things:

  • project description
  • tool dependencies (node, git, etc)
  • how to run the project
  • how to set yourself up so you can work on the project (often more work than the point above)
  • libraries: API details
  • stand-alone: env vars
  • further links, sometimes?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant