Actualize documentation
All checks were successful
CI / Check spelling (pull_request) Successful in 15s
CI / Check coding style (pull_request) Successful in 28s
CI / Linux (arch) (pull_request) Successful in 11m33s
CI / Linux (debian) (pull_request) Successful in 11m43s
CI / Linux (ubuntu) (pull_request) Successful in 11m44s
CI / Linux (fedora) (pull_request) Successful in 13m21s
All checks were successful
CI / Check spelling (pull_request) Successful in 15s
CI / Check coding style (pull_request) Successful in 28s
CI / Linux (arch) (pull_request) Successful in 11m33s
CI / Linux (debian) (pull_request) Successful in 11m43s
CI / Linux (ubuntu) (pull_request) Successful in 11m44s
CI / Linux (fedora) (pull_request) Successful in 13m21s
This fork is not affiliated with the original Profanity, therefore information from the docs is partially invalid. The docs are going to be updated once the website is added.
This commit is contained in:
12
.github/FUNDING.yml
vendored
12
.github/FUNDING.yml
vendored
@@ -1,12 +0,0 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: jubalh
|
||||
patreon: # Replace with Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
otechie: # Replace with a single Otechie username
|
||||
custom: # Replace with a single custom sponsorship URL
|
||||
2
.github/ISSUE_TEMPLATE
vendored
2
.github/ISSUE_TEMPLATE
vendored
@@ -20,8 +20,6 @@
|
||||
<!--- Give us a screenshot (if it's helpful for this particular bug) -->
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
4.
|
||||
|
||||
## Context
|
||||
<!--- How has this issue affected you? What are you trying to accomplish? -->
|
||||
|
||||
4
.github/pull_request_template.md
vendored
4
.github/pull_request_template.md
vendored
@@ -5,5 +5,5 @@
|
||||
- [ ] I ran valgrind when using my new feature
|
||||
|
||||
### How to test the functionality
|
||||
* step 1
|
||||
* step 2
|
||||
- step 1
|
||||
- step 2
|
||||
|
||||
@@ -10,8 +10,8 @@ We recommend for people to always work on a dedicated git branch for each fix or
|
||||
Don't work on master.
|
||||
So that they can easily pull master and rebase their work if needed.
|
||||
|
||||
For fixing (reported) bugs we usually use `git checkout -b fix/issuenumber-somedescription`.
|
||||
When working on a new feature we usually use `git checkout -b feature/optionalissuenumber-somedescription`.
|
||||
For fixing (reported) bugs we usually use `git switch -c fix/issuenumber-somedescription`.
|
||||
When working on a new feature we usually use `git switch -c feature/optionalissuenumber-somedescription`.
|
||||
|
||||
However this is not a rule just a recommendation to keep an overview of things.
|
||||
If your change isn't a bugfix or new feature you can also just use any branch name.
|
||||
|
||||
37
README.md
37
README.md
@@ -3,8 +3,6 @@
|
||||
|
||||
Profanity is a console based XMPP client inspired by [Irssi](http://www.irssi.org/).
|
||||
|
||||
If you like Profanity consider becoming a sponsor or [donate](https://profanity-im.github.io/donate.html) some money.
|
||||
|
||||

|
||||
|
||||
See the [User Guide](https://profanity-im.github.io/userguide.html) for information on installing and using Profanity.
|
||||
@@ -12,26 +10,10 @@ See the [User Guide](https://profanity-im.github.io/userguide.html) for informat
|
||||
## 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.
|
||||
|
||||
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).
|
||||
|
||||
## 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.
|
||||
|
||||
## 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.
|
||||
|
||||
An alternative way to support us would be to ask for our IBAN or use Bitcoin: `bc1qx265eat7hfasqkqmk9qf38delydnrnuvzhzy0x`.
|
||||
|
||||
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.
|
||||
|
||||
Tasks from our [sponsors](SPONSORS.md) will be tackled first.
|
||||
|
||||
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:
|
||||
@@ -40,26 +22,19 @@ 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 have are having a problem then first search the [issue tracker](https://github.com/profanity-im/profanity/issues).
|
||||
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
|
||||
URL: https://profanity-im.github.io
|
||||
<!-- TODO:
|
||||
URL: https://jabber.space/
|
||||
-->
|
||||
|
||||
Repo: https://github.com/profanity-im/profanity-im.github.io
|
||||
Repo: https://git.jabber.space/devs/profanity
|
||||
|
||||
### Blog
|
||||
URL: https://profanity-im.github.io/blog
|
||||
|
||||
Repo: https://github.com/profanity-im/blog
|
||||
|
||||
### Mailinglist
|
||||
Mailing List: https://lists.posteo.de/listinfo/profanity
|
||||
|
||||
### Chatroom
|
||||
MUC: profanity@rooms.dismail.de
|
||||
<!-- TODO: blog/docs link -->
|
||||
|
||||
### Plugins
|
||||
Plugins repository: https://github.com/profanity-im/profanity-plugins
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
* Generate HTML docs (the docgen argument only works when package status is development)
|
||||
`./profanity docgen`
|
||||
|
||||
* Determine if libprofanitys version needs to be [increased](https://github.com/profanity-im/profanity/issues/973)
|
||||
* Determine if `libprofanity`'s version needs to be [increased](https://github.com/profanity-im/profanity/issues/973)
|
||||
* Update plugin API docs (./apidocs/c and ./apidocs/python) need to run the `gen.sh` and commit the results to the website git repo
|
||||
* Update CHANGELOG
|
||||
* Update profrc.example
|
||||
|
||||
22
SPONSORS.md
22
SPONSORS.md
@@ -1,22 +0,0 @@
|
||||
# Giving back
|
||||
|
||||
Thank you very much to all of our sponsors and donors (including those that want to stay private)!
|
||||
|
||||
## Sponsors
|
||||
[Martin Dosch](https://github.com/mdosch) since January 2020
|
||||
|
||||
[Alexander Dahl](https://github.com/LeSpocky) since January 2021
|
||||
|
||||
[James Pond](https://github.com/jamesponddotco) since February 2021
|
||||
|
||||
## Donors
|
||||
[Martin Dosch](https://github.com/mdosch)
|
||||
|
||||
[Julian Huhn](https://github.com/huhndev)
|
||||
|
||||
[Matteo Bini](https://github.com/matteobin)
|
||||
|
||||
## Services
|
||||
[Stefan Kropp](https://github.com/StefanKropp) for sponsoring our [mailing list](https://lists.posteo.de/listinfo/profanity)
|
||||
|
||||
[dismail](https://dismail.de/) for hosting our [MUC](xmpp:profanity@rooms.dismail.de?join)
|
||||
Reference in New Issue
Block a user