trinity/README.md

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

![Screenshot](misc/screenshot.png)

## 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

## Installation

I'm not providing any pre-built binaries yet, so you must compile from source.

If you use Arch Linux, I maintain the [AUR package](https://aur.archlinux.org/packages/trinity-matrix-git).

## Building

Building Trinity is very easy, simply call CMake. Please make sure all the dependencies below are met.

### Dependencies
* Qt5
  * WebEngine is also required
* CMark
* libolm
Add old files 2021-07-21 16:08:15 -04:00			`# Trinity`
Update README 2022-03-01 16:26:55 -05:00			`A Qt5 QML Matrix client, which supports end-to-end encryption (WIP) and has a Discord-like interface.`
Add old files 2021-07-21 16:08:15 -04:00
Reformat code 2022-08-15 21:53:56 -04:00			`![Screenshot](misc/screenshot.png)`

Add old files 2021-07-21 16:08:15 -04:00			`## Features`
			`* Basic messaging capabilities`
			`* Sending and recieving markdown messages, formatting can be disabled`
			`* Typing notifications`
Update README 2022-03-01 16:26:55 -05:00			`* End-to-end encryption (WIP)`
			`* Community support`
Add old files 2021-07-21 16:08:15 -04:00			`* 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`

Reformat code 2022-08-15 21:53:56 -04:00			`## Installation`

			`I'm not providing any pre-built binaries yet, so you must compile from source.`

			`If you use Arch Linux, I maintain the [AUR package](https://aur.archlinux.org/packages/trinity-matrix-git).`

			`## Building`
Add old files 2021-07-21 16:08:15 -04:00
Reformat code 2022-08-15 21:53:56 -04:00			`Building Trinity is very easy, simply call CMake. Please make sure all the dependencies below are met.`
Update README 2022-03-01 16:26:55 -05:00
Reformat code 2022-08-15 21:53:56 -04:00			`### Dependencies`
Add old files 2021-07-21 16:08:15 -04:00			`* Qt5`
Update README 2022-03-01 16:26:55 -05:00			`* WebEngine is also required`
Add old files 2021-07-21 16:08:15 -04:00			`* CMark`
Update README 2022-03-01 16:26:55 -05:00			`* libolm`