Jabber Developer
b4d3563b96
All checks were successful
CI / Check coding style (push) Successful in 29s
CI / Check spelling (push) Successful in 16s
CI / Linux (debian) (push) Successful in 9m35s
CI / Linux (arch) (push) Successful in 11m27s
CI / Linux (fedora) (push) Successful in 13m57s
CI / Linux (ubuntu) (push) Successful in 11m21s
- Update formatting for stub files - Update docs While original project, Profanity, provides valuable basis for this fork, we are not affiliated with the upstream. This commit is updating documentation to reflect accurate information. The docs are going to be updated further once the website is created. Reviewed-on: devs/profanity#5 Co-authored-by: Jabber Developer <jabber.developer@jabber.space> Co-committed-by: Jabber Developer <jabber.developer@jabber.space>
41 lines
2.4 KiB
Markdown
41 lines
2.4 KiB
Markdown
# Profanity
|
|
 [](https://github.com/profanity-im/profanity/graphs/contributors/) [](https://repology.org/project/profanity/versions)
|
|
|
|
Profanity is a console based XMPP client inspired by [Irssi](http://www.irssi.org/).
|
|
|
|
|
|
|
|
See the [User Guide](https://profanity-im.github.io/userguide.html) for information on installing and using Profanity.
|
|
|
|
## Project
|
|
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.
|
|
|
|
|
|
## 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.
|
|
|
|
## 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/).
|
|
For more technical details check out our [CONTRIBUTING.md](CONTRIBUTING.md) file.
|
|
|
|
## 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 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.
|
|
|
|
## Links
|
|
|
|
### Website
|
|
<!-- TODO:
|
|
URL: https://jabber.space/
|
|
-->
|
|
|
|
Repo: https://git.jabber.space/devs/profanity
|
|
|
|
<!-- TODO: blog/docs link -->
|
|
|
|
### Plugins
|
|
Plugins repository: https://github.com/profanity-im/profanity-plugins
|