matrixion/README.md

80 lines
2 KiB
Markdown
Raw Normal View History

2017-04-06 04:03:46 +03:00
nheko
----
2017-04-09 17:09:22 +03:00
[![Build Status](https://travis-ci.org/mujx/nheko.svg?branch=master)](https://travis-ci.org/mujx/nheko) [![Build status](https://ci.appveyor.com/api/projects/status/07qrqbfylsg4hw2h/branch/master?svg=true)](https://ci.appveyor.com/project/mujx/nheko/branch/master)
2017-04-06 04:03:46 +03:00
The motivation behind the project is to provide a native desktop app for [Matrix] that
feels more like a mainstream chat app ([Riot], Telegram etc) and less like an IRC client.
2017-04-24 00:40:24 +03:00
Join the discussion on Matrix [#nheko:matrix.org](https://matrix.to/#/#nheko:matrix.org).
2017-04-09 03:54:39 +03:00
### Features
2017-04-06 04:03:46 +03:00
Most of the features you'd expect from a chat application are missing right now
but you can of course receive and send messages in the rooms that you are a member of.
2017-04-09 03:54:39 +03:00
### Requirements
2017-04-06 04:03:46 +03:00
2017-04-10 02:28:06 +03:00
- Qt5 (5.8 is used for development).
- CMake 3.1 or greater.
- A compiler that supports C++11.
- Clang 3.3 (or greater).
2017-04-11 19:21:11 +03:00
- GCC 4.8 (or greater).
2017-04-06 04:03:46 +03:00
2017-04-09 03:54:39 +03:00
##### Arch Linux
2017-04-06 04:03:46 +03:00
```bash
$ sudo pacman -S qt5-base cmake gcc
```
2017-04-10 02:28:06 +03:00
##### Ubuntu 14.04
```bash
$ sudo add-apt-repository ppa:beineri/opt-qt562-trusty
$ sudo add-apt-repository ppa:george-edison55/cmake-3.x
$ sudo apt-get update
2017-04-11 19:21:11 +03:00
$ sudo apt-get install qt56base cmake
2017-04-10 02:28:06 +03:00
```
2017-04-06 04:03:46 +03:00
2017-04-10 02:28:06 +03:00
##### OSX (Xcode 7 or later)
```bash
$ brew update
$ brew install qt5
```
### Building
```bash
cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Release # Default is Debug.
make -C build
```
The `nheko` binary will be located in the `build` directory.
2017-04-06 04:03:46 +03:00
2017-04-10 02:28:06 +03:00
[Here](https://ci.appveyor.com/project/mujx/nheko/branch/master/artifacts) you can
find development builds for Windows.
2017-04-09 03:54:39 +03:00
### Contributing
2017-04-06 04:03:46 +03:00
Any kind of contribution to the project is greatly appreciated. You are also
encouraged to open feature request issues.
2017-04-09 03:54:39 +03:00
### Screens
2017-04-06 04:03:46 +03:00
Here is a screen shot to get a feel for the UI, but things will probably change.
2017-04-26 02:52:51 +03:00
![nheko](https://dl.dropboxusercontent.com/s/cs2891enrf2lqo9/nheko.jpg)
2017-04-06 04:03:46 +03:00
2017-04-19 19:38:39 +03:00
### Third party
- [Emoji One](http://emojione.com)
- [Open Sans](https://fonts.google.com/specimen/Open+Sans)
2017-04-06 04:03:46 +03:00
2017-04-09 03:54:39 +03:00
### License
2017-04-06 04:03:46 +03:00
[GPLv3]
[Matrix]:https://matrix.org
[Riot]:https://riot.im
[GPLv3]:https://www.gnu.org/licenses/gpl-3.0.en.html