Skip to content
Snippets Groups Projects
README.md 2.13 KiB
Newer Older
  • Learn to ignore specific revisions
  • Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    nheko
    ----
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    [![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)
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    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.
    
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    Join the discussion on Matrix [#nheko:matrix.org](https://matrix.to/#/#nheko:matrix.org).
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    ### Features
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    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.
    
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    ### Requirements
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    
    - Qt5 (5.7 or greater). Qt 5.7 adds support for color font rendering with
      Freetype, which is essential to properly support emoji.
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    - CMake 3.1 or greater.
    - A compiler that supports C++11.
        - Clang 3.3 (or greater).
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
        - GCC 4.8 (or greater).
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    ##### Arch Linux
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    ```bash
    
    $ sudo pacman -S qt5-base cmake gcc fontconfig
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    ```
    
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    ##### Ubuntu 14.04
    
    ```bash
    
    $ sudo add-apt-repository ppa:beineri/opt-qt58-trusty
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    $ sudo add-apt-repository ppa:george-edison55/cmake-3.x
    $ sudo apt-get update
    
    $ sudo apt-get install qt58base cmake
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    ```
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    ##### 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.
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    [Here](https://ci.appveyor.com/project/mujx/nheko/branch/master/artifacts) you can
    find development builds for Windows.
    
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    ### Contributing
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    Any kind of contribution to the project is greatly appreciated. You are also
    encouraged to open feature request issues.
    
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    ### Screens
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    Here is a screen shot to get a feel for the UI, but things will probably change.
    
    
    ![nheko](https://dl.dropboxusercontent.com/s/cs2891enrf2lqo9/nheko.jpg)
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    
    ### Third party
    
    - [Emoji One](http://emojione.com)
    - [Open Sans](https://fonts.google.com/specimen/Open+Sans)
    
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    ### License
    
    Konstantinos Sideris's avatar
    Konstantinos Sideris committed
    
    [GPLv3]
    
    [Matrix]:https://matrix.org
    [Riot]:https://riot.im
    [GPLv3]:https://www.gnu.org/licenses/gpl-3.0.en.html