trinity/README.md

# Trinity
A Qt5 QML Matrix client, which supports end-to-end encryption (WIP) and has a Discord-like interface.

## Features
* Basic messaging capabilities
  * Sending and recieving markdown messages, formatting can be disabled
  * Typing notifications
* End-to-end encryption (WIP)
* Community support
* Per-room notification settings
* Listing and joining public rooms
  * Inviting other members and accepting other people's invites
* Start direct chats with other members
* Custom emote support

## Screenshots
![Screenshot](misc/screenshot.png)

*Note: This is an outdated screenshot :-)*

## Dependencies
* Qt5
  * WebEngine is also required
* CMark
* libolm

## Installation
There's no pre-compiled binaries yet, but compiling from source is easily provided you have Qt5 installed. If you use
Arch Linux, there's a [PKGBUILD available from the AUR](https://aur.archlinux.org/packages/trinity-matrix-git). Simply call it from `makepkg` or through your favorite AUR helper:

```
$ aur sync trinity-matrix-git
```

Since there's not a tagged release yet, there's only the git version available as a PKGBUILD at the moment.

## Licensing
Trinity's source code is distributed under the GPLv3 license. See the `LICENSE` file for more details.

`resources/background.jpg` shown on the login page is from Death to Stock.