Begin with an introductory paragraph that tells readers the purpose of the project and its main features.
Provide a summary of the information included in this document.
This section expands on the introductory paragraph to give readers a better understanding of the project and its purpose.
Include an outline of the technologies in the project, such as platform, programming language, framework, etc.
If you mention something, please provide links.
Provide instructions to get a copy of the project up and running on your a machine.
What kind of hardware and operating system do you need to have to install the software?
In this section also include detailed instructions for installing additional software the application is dependent upon (such as a database, for example).
$ installation command Give step-by-step instructions on building and running the project.
Describe the step.
$ command1And repeat until finished. Describe the expected outcomes of each command, including screenshots, when relevant.
$ command2Explain how to run the (automated) tests for the project.
Explain the tests and their expected outcome.
$ test commandGive a tour of the best features of the application.
Add screenshots when relevant.
Add additional notes about how to deploy this on a server machine or a cloud provider.
Mention virtualization/container tools and commands.
$ deployment commandProvide instructions for connecting to servers and tell clients how to obtain necessary permissions.
- Billie Thompson - Initial work - PurpleBooth
See also the list of contributors who participated in this project.
SemVer used for versioning.
For the versions available, see the tags on this repository.
This project is licensed under the MIT License - see the LICENSE.md file for details.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Inspiration
- etc