Yea 😄, This actually my first post on hashnode 🎉.
So I have actually joined a different team of developers to work on an existing project and sometimes I just find it difficult to get started by running the project development mode on the machine why because the project has no readme or detailed readme docs for guidance.
The is actually the challenge I have encountered most of the time and I have decided to put up a basic example of how a readme file should look like and why it's very important for every project repository on GitHub.
Why READMEs are helpful
First-timers visiting the project will get to know about the project(Tech stack, technologies used e.t.c)
How to easily get started with the project by running the application
Get detailed information on how to contribute to the project
You can get more information on Github readme by visiting their documentation page here about-readme
README.md Example
So basically I came up with this readme example file you can use to kick start your own project
You can find the link to the Github repo here readme-exmaple-repo.
Try it out yourself 🤗
Feel to drop comments and give feedback.
Thanks.