It should be linked to the Github domain
At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions of repository
A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.
Provide code examples and explanations of how to get the project.
Provide additional plugins for the software
OS system should be described. and the system configuration should also be mentioned in this
Describe and show how to run the tests with code examples.
Projects that is linked with this repository or software should be mentioned
| Project | Description |
|---|---|
| Project Name | Description. |
Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
A short snippet describing the license (MIT, Apache, etc.)