With the use of version control, there is a huge struggle among some people to do a brief of what their project is about. Lets face it, most developers are not into typing out prose to explain what they just built. Others dread the whole process of documenting it.
In addition, what to include so that someone else working on their project can benefit from their amazing work can sometimes be a hard task.
I made your life easier : I built readMe Master templates.
An open source project that allows you to get started with a well written ReadMe file file on your projects.
ReadMe MasterTemplates:
- Gives developers an easy time when writing their project ReadMe.
- Enable more time to be spent coding out their projects.
- Help us have better GitHub projects without one liners of how the project works.
- Help people who want to use your project on GitHub to know more about the project's architecture.
HOW TO USE IT:
There are different Markdown templates for each type of project as below:
Copy the respective files depending on the type of project.
Paste it and edit the file plus respecitve images.
Use it for free, raise an issue, contribute and share to the world!
Up vote on product hunt if you think will help a developer
Happy using!