Place logos here, if they exist
Begin with an introductory paragraph that tells readers the purpose of your software and its major benefits.
Give them a summary of the information you will include in this document using clearly defined sections.
This section expands on the introductory paragraph to give readers a better understanding of your project.
Include a brief description and answer the question, "what problem does this project solve?"
Include an outline of the technologies in the project, such as framework (Rails/iOS/Android), as well as programming language, database, links to any related projects (for example, whether this API has corresponding iOS or Android clients), links to online tools related to the application (such as the project web site, the shared file storage).
If you mention something, please provide links.
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 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 PostgreSQL database, for example).
Give installation command examples
Give step-by-step instructions on building and running the application on the development environment.
Describe the step.
Give the command example
And repeat.
until finished
You can also add screenshots to show expected results, when relevant.
Explain how to run the automated tests for this system.
Give users explicit instructions on how to run all necessary tests.
Explain the libraries, such as JUnit, used for testing your software and supply all necessary commands.
Explain what these tests test and why
Give an example command
Give a tour of the best features of the application.
Add screenshots when relevant.
Add additional notes about how to deploy this on a host machine or a cloud provider.
Mention virtualization/container tools and commands.
Give an example command
Provide 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.
We use SemVer 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.
- Hat tip to anyone whose code was used
- Inspiration
- etc