- What the project is about? (short project description)
- Why does this project exist? (short motivation)
- What makes your project stand out? (features)
- Instructions to get copy of the project
- Instructions to run project on local machine (for development and testing)
- What is needed to install the software?
- How to install it?
Give examples
- Show what the library does.
- How does your project solve developers problem (see: code example).
- Show an obvious API
- Make code short and concise.
- How to get development environment running?
- step-by-step series of examples (descriptions, how to install, step by step) Step 1
Give the example
Repeat
until finished
End with Example of
- getting some data out of the system
- using data for a little demo
Include logo/demo screenshot.
- What is the build status of continus integration?
- Which code styles are used for this project?
- PIMD uses the StandardJS style.
- Explain how to run the automated tests for this system
- Explain what these tests test and why
Give an example
- Explain what these tests test and why
Give an example
Add additional notes about how to deploy this on a live system
How to use? If people like your project they’ll want to learn how they can use it. To do so include step by step guide to use your project.
This ... is built with the following dependencies (tech/frameworks):
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Copyright 2018++ -NAME.
- Get in touch with @NAME on Twitter or open an issue.
- contributors who participated in this project.
This project is licensed under the MIT License. See MIT-LICENSE for details.
- Hat tip to anyone whose code was used
- Inspiration