tan
/
Spectral
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

This commit is contained in:
Black Hat 2018-08-18 08:45:21 +00:00
parent 590dcc1e5e
commit fa4da3c91e
1 changed files with 26 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -1,9 +1,10 @@
# Matrique # Matrique
[![pipeline status](https://gitlab.com/b0/matrique/badges/master/pipeline.svg)](https://gitlab.com/b0/matrique/commits/master) [![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) [![coverage report](https://gitlab.com/b0/matrique/badges/master/coverage.svg)](https://gitlab.com/b0/matrique/commits/master)
<a href='https://flathub.org/apps/details/org.eu.encom.matrique'><img width='240' alt='Get it on Flathub' src='https://flathub.org/assets/badges/flathub-badge-i-en.png'/></a>
> "Nobody can be told what the matrix is, you have to see it for yourself. " > "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. Matrique is a glossy cross-platform client for Matrix, the decentralized communication protocol for instant messaging.
@ -12,30 +13,21 @@ Matrique is a glossy cross-platform client for Matrix, the decentralized communi
You can reach the maintainer at #matrique:matrix.org, if you are already on Matrix. 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. Also, you can file an issue at this project if anything goes wrong.
## Install ## Download
You can fetch the nightly release of Matrique via Flatpak. You can fetch the release of Matrique on Flathub. The link is at the beginning of this README.
Alternatively, you can download the Flatpak nightly build bundle from here: ![Download Bundle](https://gitlab.com/b0/matrique/-/jobs/artifacts/dev/raw/flatpak/matrique.flatpak?job=build-flatpak)
Open the bundle using your preferred software center.
### Requirements ### Requirements
An operating system with Flatpak installed. 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. 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. *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.* No precompiled binary for MacOS and Microsoft Windows yet.*
@ -53,18 +45,33 @@ flatpak run org.eu.encom.matrique
You can compile Matrique from source if you want to. You can compile Matrique from source if you want to.
The requirements are Qt, QMake, Qt Quick, Qt Quick Controls 2, Qt Multimedia, and several others.
* Fetch the code. * Fetch the code.
``` ```bash
git clone --recursive https://gitlab.com/b0/matrique git clone --recursive https://gitlab.com/b0/matrique
``` ```
* Open in Qt Creator using the default config. * Open in Qt Creator using the default config.
* Run. * Run.
*Still prefer commands?*
```bash
mkdir build && cd build
qmake ..
make
sudo make install
```
## Acknowledgement ## Acknowledgement
This program uses libqmatrixclient library and C++ models from Quaternion. This program uses libqmatrixclient library and C++ models from Quaternion.
![Quaternion](https://github.com/QMatrixClient/Quaternion)
![libqmatrixclient](https://github.com/QMatrixClient/libqmatrixclient)
## License ## License