TODO:A description of your project follows. A good description is clear, short, and to the point. Describe the importance of your project, and what it does.
TODO: Optionally, include a table of contents in order to allow other people to quickly naviagte especially long or detailed READMEs.
These instructions will get you a copy of the project up and running on your local machine. See deployment for notes on how to deploy the project on a live system.
(Preperatrion to install)
Installation is the next section in an effective README. Tell other users how to install your project locally. Optionally, include a gif to make the process even more clear for other people.
TODO: The next section is usage, in which you instruct other people on how to use your project after they’ve installed it. This would also be a good place to include screenshots of your project in action.
How to test wheather the product works
Add additional notes about how to deploy this on a live system
- List of things used to build product
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Larger projects often have sections on contributing to their project, in which contribution instructions are outlined. Sometimes, this is a separate file. If you have specific contribution preferences, explain them so that other developers know how to best contribute to your work. To learn more about how to help others contribute, check out the guide for (setting guidelines for repository contributors)[https://help.github.com/articles/setting-guidelines-for-repository-contributors/].
Say what versioning method you use.
example: We use SemVer for versioning. For the versions available, see the tags on this repository.
- AuthorName - What they do - USER
See also the list of contributors who participated in this project.
TODO: Finally, include a section for the license of your project. For more information on choosing a license, check out GitHub’s licensing guide!
-
Hat tip to anyone who's code was used
-
Inspiration
-
etc