You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.
README files typically include information on:
- Primary Features - What does this project do?
- Target Audience - Who is it for?
- Purpose - Why the project is useful/what problem does it solve?
- Getting Started - How can someone test out the project?
- Help - Where/How can users get help with your project?
- Contributions - Who contributed to this project/What did they contribute?
Other things you may want to include are:
- Images of ERD, Wirframes, etc.
- Images of finished product
- Animated Demos of primary features in action
- Link to your planning documentation
How To Add Animated Demos (Gifs) To Your README.md
Gifski - Turn videos into gifs
7 Ways You Can Take A Screenshot on Windows 10
How To Take A Screenshot On Your Mac
Markdown is a plain text formatting syntax aimed at making writing for the internet easier.
Make A README - Suggested Template
Wide Retriever - Client Side Capstone by Monica Kay Provence
Rare: Media Publication App by Team News Hounds