236 lines
6.4 KiB
Markdown
236 lines
6.4 KiB
Markdown
<h1 align="center">
|
|
<a href="https://gitdab.com/${REPO_OWNER}/${REPO_NAME}">
|
|
<img src="docs/images/logo.png" alt="Logo" width="100" height="100">
|
|
</a>
|
|
<br />
|
|
${REPO_NAME}
|
|
</h1>
|
|
|
|
> **[?]**
|
|
> Switch for your own logo
|
|
|
|
<div align="center">
|
|
<i>${REPO_DESCRIPTION}</i>
|
|
<br />
|
|
<a href="https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues/new">
|
|
Report a Bug
|
|
</a>
|
|
·
|
|
<a href="https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues/new">
|
|
Request a Feature
|
|
</a>
|
|
·
|
|
<a href="https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues/new">
|
|
Ask a Question
|
|
</a>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<br />
|
|
|
|
[](LICENSE)
|
|
|
|
[](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/compare)
|
|
[](https://gitdab.com/${REPO_NAME})
|
|
|
|
</div>
|
|
|
|
## Table of Contents
|
|
|
|
- [About](#about)
|
|
- [Getting Started](#getting-started)
|
|
- [Prerequisites](#prerequisites)
|
|
- [Installation](#installation)
|
|
- [Usage](#usage)
|
|
- [Support](#support)
|
|
- [Roadmap](#roadmap)
|
|
- [Project Help](#project-help)
|
|
- [Contributing](#contributing)
|
|
- [Acknowledgements](#acknowledgements)
|
|
- [Funding Organizations](#funding-organizations)
|
|
- [Patrons](#patrons)
|
|
- [Software Used](#software-used)
|
|
- [Inspirations](#inspirations)
|
|
- [Authors and Contributors](#authors-and-contributors)
|
|
- [Security](#security)
|
|
- [License](#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?
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
> **[?]**
|
|
> List project requirements or dependencies.
|
|
> List build tools.
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
### Installation
|
|
|
|
> **[?]**
|
|
> Describe how to install and get started with the project.
|
|
> List build instructions.
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
## Usage
|
|
|
|
> **[?]**
|
|
> How does one go about using it?
|
|
> Provide various use cases and code examples here.
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
## Support
|
|
|
|
> **[?]**
|
|
> Provide additional ways to contact the project maintainer/maintainers.
|
|
> Website?
|
|
> Email?
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
## Roadmap
|
|
|
|
See the [open issues](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues)
|
|
for a list of proposed features (and known issues).
|
|
|
|
> **[?]**
|
|
> Show milestones.
|
|
> Top Feature Requests. (Add your votes using the 👍 reaction)
|
|
> Newest Bugs. (Add your votes using the 👍 reaction)
|
|
> Kanban board or other project management software.
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
## Project Help
|
|
|
|
If you want to say thank you and/or support active development of
|
|
**${REPO_NAME}**:
|
|
- Add a [GitHub Star](https://github.com/${REPO_OWNER}/${REPO_NAME}) to the
|
|
project's GitHub awareness page. This is not a mirror 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](https://dev.to/),
|
|
[Medium](https://medium.com/), or your personal blog.
|
|
- Help fund our contributors on:
|
|
- [Liberapay](https://liberapay.com)
|
|
- [Buy me a coffee](https://www.buymeacoffee.com/)
|
|
- [Ko-Fi](https://ko-fi.com/)
|
|
- [Patreon](https://www.patreon.com)
|
|
- [Kickstarter](https://www.kickstarter.com/)
|
|
- [Indiegogo](https://www.indiegogo.com/)
|
|
|
|
> **[?]**
|
|
> Replace with links to the projects own funding pages.
|
|
|
|
Together, we can make ${REPO_NAME} **better**!
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
## Contributing
|
|
|
|
First off, thanks for taking the time 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](docs/CONTRIBUTING.md), and thank you
|
|
for being involved!
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
## Acknowledgements
|
|
|
|
### Funding Organizations
|
|
|
|
> **[?]**
|
|
> Include any organizations or companies that are funding the project.
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
### Patrons
|
|
|
|
All patrons can be found at:
|
|
- [Liberapay](https://liberapay.com)
|
|
- [Buy me a coffee](https://www.buymeacoffee.com/)
|
|
- [Ko-Fi](https://ko-fi.com/)
|
|
- [Patreon](https://www.patreon.com)
|
|
- [Kickstarter](https://www.kickstarter.com/)
|
|
- [Indiegogo](https://www.indiegogo.com/)
|
|
|
|
> **[?]**
|
|
> Replace with links to own funding pages w/ patrons listed.
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
### Software Used
|
|
|
|
- The
|
|
[Amazing Github Template](https://github.com/dec0dOS/amazing-github-template)
|
|
for the README.md and some other documents.
|
|
|
|
> **[?]**
|
|
> Include libraries and applications used in the project.
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
### Inspirations
|
|
|
|
> **[?]**
|
|
> Include any projects or people that have inspired this project.
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
### 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](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/activity).
|
|
|
|
> **[?]**
|
|
> Replace once w/ contributors once
|
|
> https://github.com/go-gitea/gitea/issues/847
|
|
> is implemented.
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
## 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](docs/SECURITY.md)._
|
|
|
|
**[Back to top](#table-of-contents)**
|
|
|
|
## 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/>
|
|
|
|
**[Back to top](#table-of-contents)**
|