1
0
Fork 0
profanity/README.md

66 lines
3.8 KiB
Markdown
Raw Permalink Normal View History

# Profanity
![Build Status](https://github.com/profanity-im/profanity/workflows/CI/badge.svg) [![GitHub contributors](https://img.shields.io/github/contributors/profanity-im/profanity.svg)](https://github.com/profanity-im/profanity/graphs/contributors/) [![Packaging status](https://repology.org/badge/tiny-repos/profanity.svg)](https://repology.org/project/profanity/versions)
2012-02-09 00:51:41 +00:00
2019-12-18 15:04:35 +00:00
Profanity is a console based XMPP client inspired by [Irssi](http://www.irssi.org/).
2019-12-18 15:06:42 +00:00
2019-12-18 15:04:35 +00:00
If you like Profanity consider becoming a sponsor or [donate](https://profanity-im.github.io/donate.html) some money.
2019-12-18 15:06:42 +00:00
2020-06-05 12:54:39 +00:00
![alt tag](https://profanity-im.github.io/images/prof-2.png)
2013-08-28 00:27:21 +00:00
See the [User Guide](https://profanity-im.github.io/userguide.html) for information on installing and using Profanity.
2012-08-16 23:19:58 +00:00
2020-05-27 08:01:45 +00:00
## Project
2021-07-12 07:32:44 +00:00
This project is about freedom, privacy and choice. We want to enable people to chat with one another in a safe way. Thus supporting encryption (OTR, PGP, OMEMO, OX) and being decentralized, meaning everyone can run their own server. We believe [XMPP](https://xmpp.org/) is a great proven protocol with an excellent community serving this purpose well.
2020-05-27 08:01:45 +00:00
Feel free to follow us on [twitter](https://twitter.com/profanityim), join our [mailing list](https://lists.posteo.de/listinfo/profanity) and/or [MUC](xmpp:profanity@rooms.dismail.de?join).
2020-05-27 08:01:45 +00:00
## Installation
Our [user guide](https://profanity-im.github.io/userguide.html) contains an [install](https://profanity-im.github.io/guide/latest/install.html) section and a section for [building](https://profanity-im.github.io/guide/latest/build.html) from source yourself.
2020-05-27 07:42:11 +00:00
## 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.
2023-08-25 18:11:26 +00:00
An alternative way to support us would be to ask for our IBAN or use Bitcoin: `bc1qx265eat7hfasqkqmk9qf38delydnrnuvzhzy0x`.
2020-05-27 07:42:11 +00:00
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 comment on an issue that you are willing to sponsor it.
2020-05-27 07:42:11 +00:00
2020-05-27 07:53:44 +00:00
Tasks from our [sponsors](SPONSORS.md) will be tackled first.
2020-05-27 07:42:11 +00:00
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/).
2020-07-07 12:21:01 +00:00
For more technical details check out our [CONTRIBUTING.md](CONTRIBUTING.md) file.
2020-05-27 07:42:11 +00:00
## 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](xmpp:profanity@rooms.dismail.de?join) or create a new issue depending on what your problem is.
2020-05-27 07:42:11 +00:00
## Links
2012-08-16 23:19:58 +00:00
2020-05-27 07:42:11 +00:00
### Website
URL: https://profanity-im.github.io
2020-05-27 07:44:20 +00:00
2020-05-27 07:42:11 +00:00
Repo: https://github.com/profanity-im/profanity-im.github.io
2012-08-16 23:20:27 +00:00
2020-05-27 07:42:11 +00:00
### Blog
URL: https://profanity-im.github.io/blog
2020-05-27 07:44:20 +00:00
2020-05-27 07:42:11 +00:00
Repo: https://github.com/profanity-im/blog
2021-08-26 01:18:10 +00:00
### Mailinglist
Mailing List: https://lists.posteo.de/listinfo/profanity
2020-05-27 07:44:20 +00:00
2020-05-27 07:42:11 +00:00
### Chatroom
2019-03-13 13:56:13 +00:00
MUC: profanity@rooms.dismail.de
2020-05-27 07:42:11 +00:00
### Plugins
Plugins repository: https://github.com/profanity-im/profanity-plugins