blob: 26356ef6a70b2407f47c30966b39fa001b47b9ce (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
nheko
----
[](https://travis-ci.org/mujx/nheko)
[](https://ci.appveyor.com/project/mujx/nheko/branch/master)
[](https://matrix.to/#/#nheko:matrix.org)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://aur.archlinux.org/packages/nheko-git)
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.
### Features
Most of the features you would expect from a chat application are missing right now
but we are getting close to a more feature complete client.
Specifically there is support for:
- Joining & leaving rooms
- Sending & receiving images and emoji.
- Receiving typing notifications.
### Installation
#### Arch Linux
```bash
pacaur -S nheko-git
```
#### Fedora
```bash
sudo dnf copr enable xvitaly/matrix
sudo dnf install nheko
```
#### Gentoo Linux
```bash
sudo layman -a matrix
sudo emerge -a nheko
```
#### Windows
You can find an installer [here](https://ci.appveyor.com/project/mujx/nheko/branch/master/artifacts).
### Build Requirements
- Qt5 (5.7 or greater). Qt 5.7 adds support for color font rendering with
Freetype, which is essential to properly support emoji.
- CMake 3.1 or greater.
- [LMDB](https://symas.com/lightning-memory-mapped-database/).
- A compiler that supports C++11.
- Clang 3.3 (or greater).
- GCC 4.8 (or greater).
##### Arch Linux
```bash
sudo pacman -S qt5-base qt5-tools cmake gcc fontconfig lmdb
```
##### Gentoo Linux
```bash
sudo emerge -a ">=dev-qt/qtgui-5.7.1" media-libs/fontconfig
```
##### Ubuntu (e.g 14.04)
```bash
sudo add-apt-repository ppa:beineri/opt-qt58-trusty
sudo add-apt-repository ppa:george-edison55/cmake-3.x
sudo apt-get update
sudo apt-get install qt58base qt58tools cmake liblmdb-dev
```
##### OSX (Xcode 8 or later)
```bash
brew update
brew install qt5 lmdb
```
N.B. you will need to pass `-DCMAKE_PREFIX_PATH=/usr/local/opt/qt5`
to cmake to point it at your qt5 install (tweaking the path as needed)
### Building
Clone the repo with its submodules
```bash
git clone --recursive https://github.com/mujx/nheko
```
or
```bash
git clone https://github.com/mujx/nheko
cd nheko
git submodule update --init
```
and then use the following
```bash
cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Release # Default is Debug.
make -C build
```
The `nheko` binary will be located in the `build` directory.
##### MacOS
You can create an app bundle with `make app`. The output will be located at
`dist/MacOS/Nheko.app` which can be copied to `/Applications/Nheko.app`.
You can also create a disk image with `make dmg`. The output will be located at
`dist/MacOS/Nheko.dmg`
##### Nix
Download the repo as mentioned above and run
```bash
nix-build
```
in the project folder. This will output a binary to `result/bin/nheko`.
You can also install nheko by running `nix-env -f . -i`
### Contributing
Any kind of contribution to the project is greatly appreciated. You are also
encouraged to open feature request issues.
### Screens
Here is a screen shot to get a feel for the UI, but things will probably change.
### Third party
- [Emoji One](http://emojione.com)
- [Font Awesome](http://fontawesome.io/)
- [Open Sans](https://fonts.google.com/specimen/Open+Sans)
[Matrix]:https://matrix.org
[Riot]:https://riot.im
|
