Commit a2360b0b authored by Richard Bayerle's avatar Richard Bayerle
Browse files

History mistake in README.

parent 00e06983
......@@ -10,22 +10,20 @@ If you use a version <0.6.5, you should still definitely update.
## Table of Contents
1. [Installation](#installation)
1. [Linux](#installation-linux)
2. [Windows](#installation-windows)
3. [MacOS](#installation-macos)
4. [More](#installation-more)
1. [Linux](#linux)
1. [Windows](#windows)
1. [MacOS](#macos)
1. [Additional plugins](#additional-plugins)
2. [Usage](#usage)
1. [General](#usage-general)
2. [Group Chats](#usage-mucs)
1. [General](#general)
1. [Group Chats](#group-chats)
3. [Bug Reports](#bug-reports)
4. [FAQ](#faq)
5. [Caveats](#caveats)
<a name="installation" />
## Installation
<a name="installation-linux" />
### Linux
#### 1. Install the (submodules') dependencies
##### 1. Install the (submodules') dependencies
Below you can find the command to install the dependencies for popular distribution families. Make sure that you use at least version 2.7 of _mxml_, and 2.10.10 of _libpurple_.
__Debian, Ubuntu__
......@@ -41,7 +39,7 @@ __Fedora__
sudo dnf install git cmake libpurple-devel mxml-devel libxml2-devel libsqlite3x-devel libgcrypt-devel
```
#### 2A. EITHER: Build and install from source
##### 2A. EITHER: Build and install from source
``` bash
git clone https://github.com/gkdr/lurch/
cd lurch
......@@ -54,12 +52,11 @@ The last command compiles the whole thing and copies the plugin into your local
The next time you start Pidgin, or another libpurple client, you should be able to activate it in the "Plugins" window.
#### 2B. OR: Install from a community repo
##### 2B. OR: Install from a community repo
* Arch - AUR: https://aur.archlinux.org/packages/libpurple-lurch-git/
* Fedora - COPR: https://copr.fedorainfracloud.org/coprs/treba/pidgin-lurch/
<a name="installation-windows" />
### Windows
Thanks to [EionRobb](https://github.com/EionRobb), Windows users can use the dlls he compiled and provides here: https://eion.robbmob.com/lurch/
......@@ -68,7 +65,6 @@ Thanks to [EionRobb](https://github.com/EionRobb), Windows users can use the dll
These instructions can also be found at the provided link.
<a name="installation-macos" />
### MacOS
Homebrew should have all dependencies:
......@@ -79,8 +75,7 @@ This should work on newer versions of MacOS, but if you run into problems check
Alternatively, if you use Adium, you should definitely check out [shtrom](https://github.com/shtrom)'s [Lurch4Adium](https://github.com/shtrom/Lurch4Adium)!
<a name="installation-more" />
### Additional plugins for more comfort
### Additional plugins
The current version of _libpurple_'s _XMPP_ protocol plugin does not support many _XEPs_ by itself. For more features and compatibility with other clients such as _Conversations_ you can install the pulgins below.
#### carbons
......@@ -93,9 +88,7 @@ In order to support the checkmarks for delivered messages, you could install thi
https://app.assembla.com/spaces/pidgin-xmpp-receipts/git/source
<a name="usage" />
## Usage
<a name="usage-general" />
### General
The first thing you can do to check if this plugin works is enter the `/lurch help` command in any conversation window. You will receive a list of the other commands you can use. I know this is a bit clunky, but using the command interface for interactions makes the plugin usable in clients that do not have a GUI.
......@@ -103,7 +96,6 @@ After you have made sure it was installed correctly, you do not have to activate
This plugin will set the window title to notify the user if encryption is enabled or not. If it is, it will generally not send plaintext messages. If a plaintext message is received in a chat that is supposed to be encrypted, the user will be warned.
<a name="usage-mucs" />
### Group Chats
Group chats (via [XEP-0045: Multi-User Chat](https://xmpp.org/extensions/xep-0045.html) aka MUCs) are __not__ part of the _OMEMO_ specification, but can work under specific circumstances as outlined on the [_Conversations_ README](https://github.com/siacs/Conversations/blob/master/README.md#omemo). These are:
* The MUC has to be non-anonymous so the real JID of each participant is visible. The channel owner has to set this property. In Pidgin you can get there by typing `/config`.
......@@ -113,7 +105,6 @@ Once you have confirmed these conditions are met, every member has to activate _
It is __recommended__ you confirm the fingerprints look the same on each device, including among your own.To do this, you can e.g. display all fingerprints participating in a conversation using `/lurch show fp conv`.
<a name="bug-reports" />
## Bug Reports
If something does not work as expected, don't hesitate to open an issue.
You can also reach me on the Pidgin IRC channel (#pidgin on freenode) as `riba`, or send me an email.
......@@ -128,7 +119,6 @@ You can obtain it in the following way:
* When it does crash, type `bt` (or `backtrace`)
* Copy the whole thing
<a name="faq" />
## FAQ
### Can it talk to other OMEMO clients?
__Yes__, it was (briefly) tested with:
......@@ -141,7 +131,6 @@ See https://omemo.top/ for additional clients.
### Does it work with Finch?
It should, but I only tried it briefly.
<a name="caveats" />
## Caveats
_OMEMO_ is not 'whatever Conversations can do', but a very specific _XEP_.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment