This is a sample README file. It is required to have all sections below at the minimum but feel free to add more if you want. Also, it is recommended to follow the same formats with headers, bullet points, highlights...
Here is a README.md example: https://github.com/drphamwit/SE-SampleGithubRepo/blob/master/README-Example.md
Briefly describe what your project is all about.
List all the features (use cases) of your application.
- Feature #1
- Feature #2
- Feature #3
- ...
List all the steps on how to install and setup your project
List all the steps on how to run your project
Upload your demo video to youtube and put a link here. Basically, the video content is very much like the quick live demo of your product with the followings:
- Introduction
- How to run the app
- Quick walkthrough of all the features of your app one by one
Please make it short and interesting!
Sample: https://www.youtube.com/watch?v=Pr-JMqTkdEM
How to record your screen: https://www.techradar.com/how-to/record-your-screen
- John Doe, Team Lead
- Alan Smith, Bug Fixer