nheko/README.md

3.0 KiB

nheko

Build Status Build status Translation Status

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.

Join the discussion on Matrix #nheko:matrix.org.

Features

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.

Installation

Arch Linux

pacaur -S nheko-git

Gentoo Linux

sudo layman -a matrix
sudo emerge -a nheko

Windows

You can find a NSIS installer here.

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.
  • A compiler that supports C++11.
    • Clang 3.3 (or greater).
    • GCC 4.8 (or greater).
Arch Linux
sudo pacman -S qt5-base qt5-tools cmake gcc fontconfig lmdb
Gentoo Linux
sudo emerge -a ">=dev-qt/qtgui-5.7.1" media-libs/fontconfig
Ubuntu (e.g 14.04)
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 7 or later)
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

git clone --recursive https://github.com/mujx/nheko

or

git clone https://github.com/mujx/nheko
cd nheko
git submodule update --init

and then use the following

cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Release # Default is Debug.
make -C build

The nheko binary will be located in the build directory.

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.

nheko

Third party

License

GPLv3