Refactor: Write a better readme

Question

Refactor: Write a better readme

Closed this issue 8 months ago · 0 comments

SirrorsMoore1975 commented 10 months ago

A proper Read me file should have the following features:-

Introduction
Deploying Website location
Index (if necessary)
Instructions on how to use the app
How to set up on your local machine
Special / Unique features that user/dev needed to pay attention to
Contributions (optional)
Credits (optional)
License (optional)

README should be updated when key features has been changed, maintained and synchronized regularly with each update. If there are any further requirement, create another issue so that a contributor might be able to work on it on another branches.
https://dev.to/nikhilgautam090696/how-to-store-images-on-github--3eib
https://medium.com/@minamimunakata/how-to-store-images-for-use-in-readme-md-on-github-9fb54256e951

NB: It is possible to use an empty branch to store picture so that when this branches is merged with main, new branches does not also hold the same resources to be used in the README.md.