Playing with markdown in carpentries workshop.
Things to include:
- Project title
- Project description (keep it brief)
- What does it do? is a <utility/tool/data/script> that allows <whoever you're making this for> to do .
- Brief justification of why you made this.
- List dependencies (things that you need in order to make this work).
- Known challenges, bugs, or planned future features
- (Optional) Table of Contents
- Link to an in-depth guide, tutorials, etc.
- How to install
- How to use
- Credits
- License
- How to contribute to project (if contributions wanted)
Style considerations: light friendly tone, brief, minimize jargon, demonstrate snippets/commands