diff options
author | Michael Vetter <jubalh@iodoru.org> | 2020-05-27 09:42:11 +0200 |
---|---|---|
committer | Michael Vetter <jubalh@iodoru.org> | 2020-05-27 09:42:11 +0200 |
commit | 65e90dbad1cfaf38d59801e7d314ccd26712cfa1 (patch) | |
tree | eff83335b601576f6b6446a76c32a9d397a507e2 | |
parent | d251b56166d95ebd8a2714c923c97295179700eb (diff) | |
download | profani-tty-65e90dbad1cfaf38d59801e7d314ccd26712cfa1.tar.gz |
Restructure readme
-rw-r--r-- | README.md | 37 |
1 files changed, 35 insertions, 2 deletions
diff --git a/README.md b/README.md index fe94a59c..72f28bcf 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,48 @@ If you like Profanity consider becoming a sponsor or [donate](https://profanity- See the [User Guide](https://profanity-im.github.io/userguide.html) for information on installing and using Profanity. +## Donations +We would highly appreciate it if you support us via [GitHub Sponsors](https://github.com/sponsors/jubalh/). Especially if you make feature requests or need help using Profanity. +Sponsoring enables us to spend time on Profanity. + +GitHub matches every donation in the first year. + +An alternative way to support us would be via [Patreon](https://www.patreon.com/jubalh) or ask for our IBAN. + +Issues backed by a sponsor will be tagged with the [sponsored](https://github.com/profanity-im/profanity/issues?q=label%3Asponsored+) label. +Feature requests that we consider out of scope, either because of interest or because of time needed to implement them, will be marked with the [unfunded](https://github.com/profanity-im/profanity/issues?q=label%3Aunfunded) label. + +Another way to sponsor us or get an issue solved is to create a [bug bounty](https://www.bountysource.com/teams/profanity/issues). +Here one sets a bounty on a certain task and once the task is completed you send the money to the person who did the work. + +Thank you! <3 + +## How to contribute +We tried to sum things up on our [helpout](https://profanity-im.github.io/helpout.html) page. +Additionally you can check out our [blog](https://profanity-im.github.io/blog/) where we have articles like: +[How to get a backtrace](https://profanity-im.github.io/blog/post/how-to-get-a-backtrace/) and [Contributing a Patch via GitHub](https://profanity-im.github.io/blog/post/contributing-a-patch-via-github/). + +## Getting help +To get help, first read our [User Guide](https://profanity-im.github.io/userguide.html) then check out the [FAQ](https://profanity-im.github.io/faq.html). +If you have are having a problem then first search the [issue tracker](https://github.com/profanity-im/profanity/issues). +If you don't find anything there either come to our [MUC](profanity@rooms.dismail.de) or create a new issue depending on what your problem is. + ## Links -Homepage: https://profanity-im.github.io/ - https://github.com/profanity-im/profanity-im.github.io +### Website +URL: https://profanity-im.github.io +Repo: https://github.com/profanity-im/profanity-im.github.io -Blog: https://profanity-im.github.io/blog/ - https://github.com/profanity-im/blog +### Blog +URL: https://profanity-im.github.io/blog +Repo: https://github.com/profanity-im/blog +### Mailinglist Mailing List: https://lists.notraces.net/mailman/listinfo/profanity Thanks to @toogley! +### Chatroom MUC: profanity@rooms.dismail.de +### Plugins Plugins repository: https://github.com/profanity-im/profanity-plugins |