Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 1.17 KiB
Newer Older
  • Learn to ignore specific revisions
    • Konstantinos Sideris's avatar
    Add readme
    Konstantinos Sideris committed
    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 
    nheko
----

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'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.

#### Requirements

Building instructions for OSX and Windows will be added.

##### Linux

- Qt5
- CMake v3.1 or greater
- GCC that supports C++11.

###### Arch Linux

```bash
$ sudo pacman -S qt5-base cmake gcc
```

#### Building
    Konstantinos Sideris's avatar
    Use const refs for the deserialized data  
    Konstantinos Sideris committed
    30 31 32 33 34 35 36 37 
    Run

```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
    Add readme
    Konstantinos Sideris committed
    38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 
    
#### 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](https://dl.dropboxusercontent.com/s/u6rsx8rsp1u2sko/screen.png)


#### License

[GPLv3]

[Matrix]:https://matrix.org
[Riot]:https://riot.im
[GPLv3]:https://www.gnu.org/licenses/gpl-3.0.en.html