diff options
| author | Konstantinos Sideris <sideris.konstantin@gmail.com> | 2017-12-21 15:10:04 +0200 |
|---|---|---|
| committer | Konstantinos Sideris <sideris.konstantin@gmail.com> | 2017-12-21 15:10:04 +0200 |
| commit | 84b5f2b5786749f1ef1074eb8c174a0b54724d9b (patch) | |
| tree | c4798810c938e56276f526b3379aa1c353bda29f | |
| parent | Fix font size inconsistencies (diff) | |
| download | nheko-84b5f2b5786749f1ef1074eb8c174a0b54724d9b.tar.xz | |
Update README
Diffstat (limited to '')
| -rw-r--r-- | Makefile | 3 | ||||
| -rw-r--r-- | README.md | 23 |
2 files changed, 17 insertions, 9 deletions
diff --git a/Makefile b/Makefile index 772af477..20d79eda 100644 --- a/Makefile +++ b/Makefile @@ -42,7 +42,6 @@ docker-app-image: image -v `pwd`:/build nheko-app-image make linux-appimage clean: - git clean -xdf - git submodule foreach git clean -xdf + rm -rf build .PHONY: build app dmg diff --git a/README.md b/README.md index 591ac8e7..62c23c50 100644 --- a/README.md +++ b/README.md @@ -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 but we are getting close to a more feature complete client. Specifically there is support for: -- Joining & leaving rooms -- Sending & receiving images and emoji. +- 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 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 ```bash @@ -49,6 +51,14 @@ sudo emerge -a nheko - Clang 3.6 (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 @@ -103,11 +113,10 @@ cd nheko git submodule update --init --recursive ``` -and then use the following +and then run ```bash -cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Release # Default is Debug. -make -C build +make release ``` 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. - + ### Third party |