d3v1l/matrixion
1
0
Fork 0
mirror of https://github.com/Nheko-Reborn/nheko.git synced 2024-10-30 09:30:47 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Konstantinos Sideris 2017-12-21 15:10:04 +02:00
parent 1705273bb8
commit 84b5f2b578
2 changed files with 17 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Makefile
View file

@ -42,7 +42,6 @@ docker-app-image: image
-v `pwd`:/build nheko-app-image make linux-appimage -v `pwd`:/build nheko-app-image make linux-appimage
clean: clean:
git clean -xdf rm -rf build
git submodule foreach git clean -xdf
.PHONY: build app dmg .PHONY: build app dmg

23
README.md
View file

@ -14,13 +14,15 @@ feels more like a mainstream chat app ([Riot], Telegram etc) and less like an IR
Most of the features you would expect from a chat application are missing right now 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. but we are getting close to a more feature complete client.
Specifically there is support for: Specifically there is support for:
- Joining & leaving rooms - Creating, joining & leaving rooms.
- Sending & receiving images and emoji. - Sending & receiving invites.
- Sending & receiving files and emoji (inline widgets for images, audio and file messages).
- Typing notifications. - Typing notifications.
- Light, Dark & System themes.
### Installation ### Installation
There are pre-built nigtly releases [here](https://github.com/mujx/nheko/releases/tag/nightly) for Linux ([AppImage](https://appimage.org/)), Mac and Windows. There are continuous nightly releases [here](https://github.com/mujx/nheko/releases/tag/nightly) for Linux ([AppImage](https://appimage.org/)), Mac and Windows.
#### Arch Linux #### Arch Linux
```bash ```bash
@ -49,6 +51,14 @@ sudo emerge -a nheko
- Clang 3.6 (or greater). - Clang 3.6 (or greater).
- GCC 4.9.4 (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 ##### Arch Linux
```bash ```bash
@ -103,11 +113,10 @@ cd nheko
git submodule update --init --recursive git submodule update --init --recursive
``` ```
and then use the following and then run
```bash ```bash
cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Release # Default is Debug. make release
make -C build
``` ```
The `nheko` binary will be located in the `build` directory. The `nheko` binary will be located in the `build` directory.
@ -133,7 +142,7 @@ encouraged to open feature request issues.
Here is a screen shot to get a feel for the UI, but things will probably change. Here is a screen shot to get a feel for the UI, but things will probably change.
![nheko](https://dl.dropboxusercontent.com/s/5iydk5r3b9zyycd/nheko-ui.png) ![nheko](https://dl.dropboxusercontent.com/s/umojysx3gv80qs9/nheko-default-theme.png)
### Third party ### Third party