mirror of
https://github.com/Nheko-Reborn/nheko.git
synced 2024-11-29 22:28:49 +03:00
44ee1b549d
The first distribution to have nheko in it's official repositories! 🎉
Right now nheko is only in the `testing` repository, but this will
be moved to `community` after a while (after which it's available
for installation out of the box).
163 lines
4.3 KiB
Markdown
163 lines
4.3 KiB
Markdown
nheko
|
|
----
|
|
[](https://travis-ci.org/mujx/nheko)
|
|
[](https://ci.appveyor.com/project/mujx/nheko/branch/master)
|
|
[](https://github.com/mujx/nheko/releases)
|
|
[](https://matrix.to/#/#nheko:matrix.org)
|
|
[](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:
|
|
- Creating, joining & leaving rooms.
|
|
- Sending & receiving invites.
|
|
- Sending & receiving files and emoji (inline widgets for images, audio and file messages).
|
|
- Typing notifications.
|
|
- Light, Dark & System themes.
|
|
|
|
### Installation
|
|
|
|
There are continuous nightly releases [here](https://github.com/mujx/nheko/releases/tag/nightly)
|
|
for Linux ([AppImage](https://appimage.org/), rpm, deb), Mac and Windows.
|
|
|
|
#### 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
|
|
```
|
|
|
|
#### Alpine Linux (and postmarketOS)
|
|
|
|
Make sure you have the testing repositories from `edge` enabled. Note that this is not needed on postmarketOS.
|
|
|
|
```sh
|
|
sudo apk add nheko
|
|
```
|
|
|
|
### 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.8 (or greater).
|
|
- GCC 4.9.4 (or greater).
|
|
|
|
#### Linux
|
|
|
|
If you don't want to install any external dependencies, you can generate an AppImage locally using docker.
|
|
|
|
```bash
|
|
make docker-app-image
|
|
```
|
|
|
|
##### Arch Linux
|
|
|
|
```bash
|
|
sudo pacman -S qt5-base qt5-tools qt5-multimedia 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-qt592-trusty
|
|
sudo add-apt-repository ppa:george-edison55/cmake-3.x
|
|
sudo apt-get update
|
|
sudo apt-get install -y qt59base qt59tools qt59multimedia cmake liblmdb-dev
|
|
```
|
|
|
|
To build on Ubuntu 14.04 Trusty out-of-the-box requires using Clang 3.6 instead of GCC:
|
|
|
|
```bash
|
|
sudo apt-get install clang-3.6
|
|
export CC=clang-3.6 CXX=clang++-3.6
|
|
```
|
|
|
|
On Ubuntu 14.04 Trusty, it's possible to use GCC 4.9.4+, but it is not recommended, because it requires installing GCC packages from third-party PPAs. Later versions of Ubuntu that come with GCC 4.9.4+ should work with GCC out-of-the-box.
|
|
|
|
##### 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 --recursive
|
|
```
|
|
|
|
and then run
|
|
|
|
```bash
|
|
make release
|
|
```
|
|
|
|
The `nheko` binary will be located in the `build` directory.
|
|
|
|
#### 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
|