A template for your project README.
Project Name
Describe what does this project does in one line followed by your project logo if you have one. e.g., who might be interested in it, what language its written in, and how it might be different from similar projects.
- Include a list of features and limitations.
- States the goals and scope of the project to help set expectations and filter proposed changes down the line.
- Include the current status (e.g., proof of concept, used in production, active development, orphaned, etc.)
- Include link to demo or production instance
Background
It includes a high-level development roadmap or link to open issues/milestones.
It explicitly asks for contributions, if you want them, with a link to CONTRIBUTING.md.
It includes a description of the kind of environment required to run the software and instructions for setting it up.
It clearly states the external dependencies and directions for installing them.
Development
This project champions the UWaterloo software practices
It includes all instructions required to build, test, and run the software.
Maintainers
XXX: Enter at least two maintainers in here who have write access to the repo.
Support
This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.
For help or questions about using this project, please XXX: REPO MAINTAINER TO INSERT INSTRUCTIONS ON HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A SLACK OR DISCORD OR OTHER CHANNEL FOR HELP. WHERE WILL YOU HELP PEOPLE?
XXX: REPO MAINTAINERS Please include one of the following statements file:
- THIS PROJECT NAME is under active development and maintained by UWaterloo staff AND THE COMMUNITY. We will do our best to respond to support, feature requests, and community questions in a timely manner.
- THIS PROJECT NAME is not actively developed but is maintained by UWaterloo staff AND THE COMMUNITY. We will do our best to respond to support and community questions in a timely manner.
- THIS PROJECT NAME is no longer supported or maintained by UWaterloo staff. We will not respond to support or community questions.
- THIS PROJECT NAME is archived and deprecated. As an unsupported project, feel free to fork.