Your Project description :
To know more about this project, please visit https://github.com/
One Paragraph of project description goes here
At the top of the file there should be a short introduction and/ or overview that explains what the project is. For example, 'Getting started' below.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
Give examples
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
Give an example
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 install and run your project.
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
Describe and show how to run the tests with code examples.
Give an example
- Prénom Nom - Initial work - mdo Let people know how they can dive into the project.
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details. A short snippet describing the license (MIT, GNU, etc.)
- Line 1
- Line 2
- etc