If you are working on your projects and using github, the README.md file is a useful file for you to write good and clear documentations for your projects. Use this readMe to get started wiyth your project ReadMe faster.
- Description
- Why the ReadMe-MasterTemplates?
- How to use them
- Technical
- To Do checkList
- Permissions
- Licence
- Versions
- Contact Information
### Description Despite the fact that you writing a technical document, it needs to be clear. Describing your project makes it easier for
### Why the ReadMe-MasterTemplates? I lecture and coach technology. With the use of version control, i have noticed a huge struggle among most people to do a brief of what their project is about. Lets face it, most developers are not into typing out prose.
In addition, most do not know what to include so that someone else working on their project can benefit.
This is the foundation behind this project. A smple project that allows you to get started with a well written **ReadMe.md** file.
ReadMe MasterTemplates aims to: * Give 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. * Help people who want to use the various projects on github to know more about the project's architecture.
### How to use them
-
All the files are in markdown format. Not important to learn markdown. That being said, it is always great to have the Markdown CheatSheet bookmarked somewhere in your browser.(If you can learn it, awesome! It will save you time...But it really is not important: the more you use markdown, the better you get at it O.o).
-
There are different Markdown templates for each type of project as below:
- Android- For android focused ReadMe
- Website- For websites with HTML, CSS and JS
- IOS ...coming soon
- Scripts ....coming soon
Want a briefed version without many files to just copy paste: use this brief
-
As a general rule, provide link to download the app/website if its published on the playstore at the description section above.
-
Want to contribute? Feel free: it's open source
### To Do checkList
- Create An Android Projects ReadMe
- Create a website ReadMe for Html and css and JS projects
- Creat a Scripts ReadMe file for Python, php, js type projects
- Create a ReadMe file for IOS projects
- Finish v1 of the project
- Minor launch for feedback and usage
[](#)
](#){kind=link}