You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
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:
The text was updated successfully, but these errors were encountered: