cvoges12/app-template
Template
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

fix(README): better writing style, grammar, and links

Browse source
This commit is contained in:
Clayton Voges 2022-02-28 17:25:22 +00:00
parent 59dcb6be11
commit 447d180e0e
1 changed files with 36 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
README.md
View file

@ -69,6 +69,9 @@
### Prerequisites ### Prerequisites
Required dependencies:
- .
> **[?]** > **[?]**
> List project requirements or dependencies. > List project requirements or dependencies.
> List build tools. > List build tools.
@ -77,6 +80,10 @@
### Installation ### Installation
Run the following to install:
```sh
```
> **[?]** > **[?]**
> Describe how to install and get started with the project. > Describe how to install and get started with the project.
> List build instructions. > List build instructions.
@ -105,34 +112,40 @@
See the [open issues](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues) See the [open issues](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues)
for a list of proposed features (and known 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. > Add number to `labels=` in link.
> Top Feature Requests. (Add your votes using the 👍 reaction) > Add Kanban board or other project management software.
> Newest Bugs. (Add your votes using the 👍 reaction)
> Kanban board or other project management software.
**[Back to top](#table-of-contents)** **[Back to top](#table-of-contents)**
## Project Help ## 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}**: **${REPO_NAME}**:
- Add a [GitHub Star](https://github.com/${REPO_OWNER}/${REPO_NAME}) to the - 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 project's GitHub awareness page. (*our project is not mirrored to prevent
Copilot. GitHub Copilot*)
- Tweet about ${REPO_NAME} or spread the word on other social media. - Tweet about ${REPO_NAME} or spread the word on other social media.
- Write interesting articles about the project on [Dev.to](https://dev.to/), - Write interesting articles about the project on [Dev.to](https://dev.to/),
[Medium](https://medium.com/), or your personal blog. [Medium](https://medium.com/), or your personal blog.
- Help fund our contributors on: - Help fund our contributors on:
- [Liberapay](https://liberapay.com) - [Liberapay](https://liberapay.com/${REPO_OWNER})
- [Buy me a coffee](https://www.buymeacoffee.com/) - [Buy me a coffee](https://www.buymeacoffee.com/${REPO_OWNER})
- [Ko-Fi](https://ko-fi.com/) - [Ko-Fi](https://ko-fi.com/${REPO_OWNER})
- [Patreon](https://www.patreon.com) - [Patreon](https://www.patreon.com)
- [Kickstarter](https://www.kickstarter.com/) - [Kickstarter](https://www.kickstarter.com/)
- [Indiegogo](https://www.indiegogo.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**! Together, we can make ${REPO_NAME} **better**!
@ -140,10 +153,11 @@ Together, we can make ${REPO_NAME} **better**!
## Contributing ## 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 Contributions are what make the open-source community such an amazing place to
learn, inspire, and create. 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 Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you
for being involved! for being involved!
@ -162,15 +176,16 @@ for being involved!
### Patrons ### Patrons
All patrons can be found at: All patrons can be found at:
- [Liberapay](https://liberapay.com) - [Liberapay](https://liberapay.com/${REPO_OWNER})
- [Buy me a coffee](https://www.buymeacoffee.com/) - [Buy me a coffee](https://www.buymeacoffee.com/${REPO_OWNER})
- [Ko-Fi](https://ko-fi.com/) - [Ko-Fi](https://ko-fi.com/${REPO_OWNER})
- [Patreon](https://www.patreon.com) - [Patreon](https://www.patreon.com)
- [Kickstarter](https://www.kickstarter.com/) - [Kickstarter](https://www.kickstarter.com/)
- [Indiegogo](https://www.indiegogo.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)** **[Back to top](#table-of-contents)**
@ -179,6 +194,7 @@ All patrons can be found at:
- The - The
[Amazing Github Template](https://github.com/dec0dOS/amazing-github-template) [Amazing Github Template](https://github.com/dec0dOS/amazing-github-template)
for the README.md and some other documents. 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. > 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). [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 > https://github.com/go-gitea/gitea/issues/847
> is implemented. > is implemented.
@ -213,7 +229,8 @@ be assured.
**${REPO_NAME}** is provided **"as is"** without any **warranty**. Use at your **${REPO_NAME}** is provided **"as is"** without any **warranty**. Use at your
own risk. 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)** **[Back to top](#table-of-contents)**