# Matrique

[![pipeline status](https://gitlab.com/b0/matrique/badges/master/pipeline.svg)](https://gitlab.com/b0/matrique/commits/master)
[![flatpak status](https://gitlab.com/b0/matrique-repo/badges/master/pipeline.svg)](https://gitlab.com/b0/matrique-repo/commits/master)
[![coverage report](https://gitlab.com/b0/matrique/badges/master/coverage.svg)](https://gitlab.com/b0/matrique/commits/master)

> "Nobody can be told what the matrix is, you have to see it for yourself. "

Matrique is a glossy cross-platform client for Matrix, the decentralized communication protocol for instant messaging.

## Contact

You can reach the maintainer at #matrique:matrix.org, if you are already on Matrix.

Also, you can file an issue at this project if anything happens to go wrong.

## Install

You can fetch the nightly release of Matrique via Flatpak.

### Requirements

An operating system with Flatpak installed.
Fedora 28 is known to work, other GNU/Linux distributions should work as well if they have Flatpak installed.

### Add Repository and Install

Flatpak Repo: ![Repo URL](https://b0.gitlab.io/matrique-repo/matrique.flatpakrepo)

Click on the address above to install the nightly repository of Matrique.

*Prefer commands?*

```bash
flatpak remote-add matrique https://b0.gitlab.io/matrique-repo/matrique.flatpakrepo
flatpak install matrique org.eu.encom.matrique
```

*P.S. In case if you haven't figured it out, the instruction above only works on Master OS. 
No precompiled binary for MacOS and Microsoft Windows yet.*

## Run

If you install Matrique through Flatpak, you should already be able to run it from the app launcher.

If not, 

```bash
flatpak run org.eu.encom.matrique
```

## Compile from Source

You can compile Matrique from source if you want to.

* Fetch the code.

```
git clone --recursive https://gitlab.com/b0/matrique
```

* Open in Qt Creator using the default config.
* Run.

## Acknowledgement

This program uses libqmatrixclient library and C++ models from Quaternion.

## License

![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png)

This program is licensed undedr GNU General Public License, Version 3.