Description: Put a meaningful, short, plain-language description of what this project is trying to accomplish and why it matters. Describe the problem(s) this project solves. Describe how this software can improve the lives of its audience.
Other things to include:
- Technology stack: Indicate the technological nature of the software, including primary programming language(s) and whether the software is intended as standalone or as a module in a framework or other ecosystem.
- Status: Alpha, Beta, 1.1, etc. It's OK to write a sentence, too. The goal is to let interested people know where this project is at. This is also a good place to link to the CHANGELOG.
- Links to production or demo instances
- Describe what sets this apart from related-projects. Linking to another doc or page is OK if this can't be expressed in a sentence or two.
Screenshot: If the software has visual components, place a screenshot after the description; e.g.,
Describe any dependencies that must be installed for this software to work. This includes programming languages, databases or other storage mechanisms, build tools, frameworks, and so forth. If specific versions of other software are required, or known not to work, call that out.
Detailed instructions on how to install, configure, and get the project running. This should be frequently tested to ensure reliability. Alternatively, link to a separate INSTALL document.
Simple example:
$ pip install PROJECT
$ npm install PROJECT --save
$ any other command
Describe the fastest possible way to get the project running.
If the software is configurable, describe it in detail, either here or in other documentation to which you link.
Show users how to use the software. Be specific. Use appropriate formatting when showing code snippets.
If the software includes automated tests, detail how to run those tests.
Document any known significant shortcomings with the software.
Instruct users how to get help with this software; this might include links to an issue tracker, wiki, mailing list, etc.
Example
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
This section should detail why people should get involved and describe key areas you are currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building important pieces, etc.
General instructions on how to contribute should be stated with a link to CONTRIBUTING.
General instructions on how to Develop for the project should be stated with a link to DEVELOPMENT, or could be merged in CONTRIBUTING.
List the main license of the project
This project is licensed under the Creative Commons Zero v1.0 Universal License - see the LICENSE file for details
All assets released under Creative Commons CC0-1.0 (Thanks CFPB) except for parts of the CONTRIBUTING.adoc which is
Copyright: 2017-2020 HERE Europe B.V. opensource@here.com
License: Apache-2.0
The SECURITY.md which is
Copyright: 2020 IEEE Open Source Maintainers Manual. saopen-security@ieee.org
License: Apache-2.0
And the CODE_OF_CONDUCT.md
Copyright: Contributor Covenant
License: Apache-2.0
Name and git-account for primary maintainer
- Projects that inspired you
- Related projects
- Books, papers, talks, or other sources that have meaningful impact or influence on this project