trinity/README.md

# Trinity
[![sourcehut](https://img.shields.io/badge/repository-sourcehut-lightgrey.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSINCiAgICB3aWR0aD0iMTI4IiBoZWlnaHQ9IjEyOCI+DQogIDxkZWZzPg0KICAgIDxmaWx0ZXIgaWQ9InNoYWRvdyIgeD0iLTEwJSIgeT0iLTEwJSIgd2lkdGg9IjEyNSUiIGhlaWdodD0iMTI1JSI+DQogICAgICA8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIxLjUiDQogICAgICAgIGZsb29kLWNvbG9yPSJibGFjayIgLz4NCiAgICA8L2ZpbHRlcj4NCiAgICA8ZmlsdGVyIGlkPSJ0ZXh0LXNoYWRvdyIgeD0iLTEwJSIgeT0iLTEwJSIgd2lkdGg9IjEyNSUiIGhlaWdodD0iMTI1JSI+DQogICAgICA8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIxLjUiDQogICAgICAgIGZsb29kLWNvbG9yPSIjQUFBIiAvPg0KICAgIDwvZmlsdGVyPg0KICA8L2RlZnM+DQogIDxjaXJjbGUgY3g9IjUwJSIgY3k9IjUwJSIgcj0iMzglIiBzdHJva2U9IndoaXRlIiBzdHJva2Utd2lkdGg9IjQlIg0KICAgIGZpbGw9Im5vbmUiIGZpbHRlcj0idXJsKCNzaGFkb3cpIiAvPg0KICA8Y2lyY2xlIGN4PSI1MCUiIGN5PSI1MCUiIHI9IjM4JSIgc3Ryb2tlPSJ3aGl0ZSIgc3Ryb2tlLXdpZHRoPSI0JSINCiAgICBmaWxsPSJub25lIiBmaWx0ZXI9InVybCgjc2hhZG93KSIgLz4NCjwvc3ZnPg0KCg==)](https://git.sr.ht/~redstrate/trinity)
[![GitHub
mirror](https://img.shields.io/badge/mirror-GitHub-black.svg?logo=github)](https://github.com/redstrate/trinity)
[![ryne.moe
mirror](https://img.shields.io/badge/mirror-ryne.moe-red.svg?logo=git)](https://git.ryne.moe/redstrate/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.
Add old files 2021-07-21 16:08:15 -04:00			`# Trinity`
Add mirror links 2022-03-22 10:10:44 -04:00			[![sourcehut](https://img.shields.io/badge/repository-sourcehut-lightgrey.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSINCiAgICB3aWR0aD0iMTI4IiBoZWlnaHQ9IjEyOCI+DQogIDxkZWZzPg0KICAgIDxmaWx0ZXIgaWQ9InNoYWRvdyIgeD0iLTEwJSIgeT0iLTEwJSIgd2lkdGg9IjEyNSUiIGhlaWdodD0iMTI1JSI+DQogICAgICA8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIxLjUiDQogICAgICAgIGZsb29kLWNvbG9yPSJibGFjayIgLz4NCiAgICA8L2ZpbHRlcj4NCiAgICA8ZmlsdGVyIGlkPSJ0ZXh0LXNoYWRvdyIgeD0iLTEwJSIgeT0iLTEwJSIgd2lkdGg9IjEyNSUiIGhlaWdodD0iMTI1JSI+DQogICAgICA8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIxLjUiDQogICAgICAgIGZsb29kLWNvbG9yPSIjQUFBIiAvPg0KICAgIDwvZmlsdGVyPg0KICA8L2RlZnM+DQogIDxjaXJjbGUgY3g9IjUwJSIgY3k9IjUwJSIgcj0iMzglIiBzdHJva2U9IndoaXRlIiBzdHJva2Utd2lkdGg9IjQlIg0KICAgIGZpbGw9Im5vbmUiIGZpbHRlcj0idXJsKCNzaGFkb3cpIiAvPg0KICA8Y2lyY2xlIGN4PSI1MCUiIGN5PSI1MCUiIHI9IjM4JSIgc3Ryb2tlPSJ3aGl0ZSIgc3Ryb2tlLXdpZHRoPSI0JSINCiAgICBmaWxsPSJub25lIiBmaWx0ZXI9InVybCgjc2hhZG93KSIgLz4NCjwvc3ZnPg0KCg==)](https://git.sr.ht/~redstrate/trinity)
			`[![GitHub`
			`mirror](https://img.shields.io/badge/mirror-GitHub-black.svg?logo=github)](https://github.com/redstrate/trinity)`
			`[![ryne.moe`
			`mirror](https://img.shields.io/badge/mirror-ryne.moe-red.svg?logo=git)](https://git.ryne.moe/redstrate/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
			`## 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`

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

Update README 2022-03-01 16:26:55 -05:00			`Note: This is an outdated screenshot :-)`

Add old files 2021-07-21 16:08:15 -04:00			`## Dependencies`
			`* 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`

			`## Installation`
Add AUR link to README 2022-03-16 10:09:00 -04:00			`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.`
Add old files 2021-07-21 16:08:15 -04:00
Update README 2022-03-01 16:26:55 -05:00			`## Licensing`
			Trinity's source code is distributed under the GPLv3 license. See the `LICENSE` file for more details.
Add old files 2021-07-21 16:08:15 -04:00
Update README 2022-03-01 16:26:55 -05:00			`resources/background.jpg` shown on the login page is from Death to Stock.