fix(README): better writing style, grammar, and links
This commit is contained in:
parent
59dcb6be11
commit
447d180e0e
55
README.md
55
README.md
|
|
@ -69,6 +69,9 @@
|
|||
|
||||
### Prerequisites
|
||||
|
||||
Required dependencies:
|
||||
- .
|
||||
|
||||
> **[?]**
|
||||
> List project requirements or dependencies.
|
||||
> List build tools.
|
||||
|
|
@ -77,6 +80,10 @@
|
|||
|
||||
### Installation
|
||||
|
||||
Run the following to install:
|
||||
```sh
|
||||
```
|
||||
|
||||
> **[?]**
|
||||
> Describe how to install and get started with the project.
|
||||
> List build instructions.
|
||||
|
|
@ -105,34 +112,40 @@
|
|||
See the [open issues](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues)
|
||||
for a list of proposed features (and known issues).
|
||||
|
||||
For some quick links:
|
||||
- [Top Feature Requests](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues?state=open&sort=mostcomment&labels=)
|
||||
- [Newest Feature Requests](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues?state=open&sort=latest&labels=)
|
||||
- [Hottest Feature Requests](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues?state=open&sort=mostcomment&labels=)
|
||||
- [Top Bugs](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues?state=open&sort=mostcommented&labels=)
|
||||
- [Newest Bugs](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues?state=open&sort=latest&labels=)
|
||||
- [Hottest Bugs](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues?state=open&sort=mostcomment&labels=)
|
||||
|
||||
> **[?]**
|
||||
> 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.
|
||||
> Add number to `labels=` in link.
|
||||
> Add 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
|
||||
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.
|
||||
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](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/)
|
||||
- [Liberapay](https://liberapay.com/${REPO_OWNER})
|
||||
- [Buy me a coffee](https://www.buymeacoffee.com/${REPO_OWNER})
|
||||
- [Ko-Fi](https://ko-fi.com/${REPO_OWNER})
|
||||
- [Patreon](https://www.patreon.com)
|
||||
- [Kickstarter](https://www.kickstarter.com/)
|
||||
- [Indiegogo](https://www.indiegogo.com/)
|
||||
|
||||
> **[?]**
|
||||
> Replace with links to the projects own funding pages.
|
||||
> Replace the above links with links to the project's own funding pages.
|
||||
|
||||
Together, we can make ${REPO_NAME} **better**!
|
||||
|
||||
|
|
@ -140,10 +153,11 @@ Together, we can make ${REPO_NAME} **better**!
|
|||
|
||||
## Contributing
|
||||
|
||||
First off, thanks for taking the time to contribute!
|
||||
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**.
|
||||
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!
|
||||
|
|
@ -162,15 +176,16 @@ for being involved!
|
|||
### 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/)
|
||||
- [Liberapay](https://liberapay.com/${REPO_OWNER})
|
||||
- [Buy me a coffee](https://www.buymeacoffee.com/${REPO_OWNER})
|
||||
- [Ko-Fi](https://ko-fi.com/${REPO_OWNER})
|
||||
- [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.
|
||||
> Replace the above links with links to the project's own funding pages w/
|
||||
> patrons listed.
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
|
|
@ -179,6 +194,7 @@ All patrons can be found at:
|
|||
- The
|
||||
[Amazing Github Template](https://github.com/dec0dOS/amazing-github-template)
|
||||
for the README.md and some other documents.
|
||||
- The [cvoges12 app-template](https://gitdab.com/cvoges12/app-template) for this template repository.
|
||||
|
||||
> **[?]**
|
||||
> Include libraries and applications used in the project.
|
||||
|
|
@ -200,7 +216,7 @@ 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
|
||||
> Replace with contributors graph once
|
||||
> https://github.com/go-gitea/gitea/issues/847
|
||||
> is implemented.
|
||||
|
||||
|
|
@ -213,7 +229,8 @@ 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)._
|
||||
_For more information and to report security issues, please refer to our
|
||||
[security documentation](docs/SECURITY.md)._
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue