7.7 KiB
${REPO_NAME}
[?] Switch for your own logo
Table of Contents
- About
- Getting Started
- Usage
- Support
- Roadmap
- Project Help
- Contributing
- Acknowledgements
- Security
- License
About
[?] Provide general information about your project here. What problem does it (intend to) solve? What is the purpose of your project? Why did you undertake it?
Getting Started
Prerequisites
Required dependencies:
- .
[?] List project requirements or dependencies. List build tools.
Installation
Run the following to install:
[?] Describe how to install and get started with the project. List build instructions.
Usage
[?] How does one go about using it? Provide various use cases and code examples here.
Support
[?] Provide additional ways to contact the project maintainer/maintainers. Website? Email?
Roadmap
See the open issues for a list of proposed features (and known issues).
For some quick links:
- Top Feature Requests
- Newest Feature Requests
- Hottest Feature Requests
- Top Bugs
- Newest Bugs
- Hottest Bugs
[?] Add number to
labels=in link. Add Kanban board or other project management software.
Project Help
If you want to say "thank you" and/or support active development of ${REPO_NAME}:
- Add a GitHub Star to the project's GitHub awareness page. (our project is not mirrored to prevent GitHub Copilot)
- Tweet about ${REPO_NAME} or spread the word on other social media.
- Write interesting articles about the project on Dev.to, Medium, or your personal blog.
- Help fund our contributors on:
[?] Replace the above links with links to the project's own funding pages.
Together, we can make ${REPO_NAME} better!
Contributing
Firstly, thanks for considering to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please read our contribution guidelines, and thank you for being involved!
Acknowledgements
Funding Organizations
[?] Include any organizations or companies that are funding the project.
Patrons
All patrons can be found at:
[?] Replace the above links with links to the project's own funding pages w/ patrons listed.
Software Used
- The Amazing Github Template for the README.md and some other documents.
- The cvoges12 app-template for this template repository.
[?] Include libraries and applications used in the project.
Inspirations
[?] Include any projects or people that have inspired this project.
Authors and contributors
The original setup of this repository is by ${REPO_OWNER}.
For a full list of all authors and contributors, see the contributors page.
[?] Replace with contributors graph once https://github.com/go-gitea/gitea/issues/847 is implemented.
Security
${REPO_NAME} follows good practices of security, but 100% security cannot be assured. ${REPO_NAME} is provided "as is" without any warranty. Use at your own risk.
For more information and to report security issues, please refer to our security documentation.
License
Copyright (C) 2022 Clayton Voges
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/