Update electron version and add compiling docs

This commit is contained in:
Andrew Morgan
2019-04-08 18:16:55 +01:00
parent c8a04cdfcc
commit 10d0b728fd
4 changed files with 70 additions and 9 deletions
+9 -2
View File
@@ -196,7 +196,7 @@ Running as a Desktop app
Riot can also be run as a desktop app, wrapped in electron. You can download a
pre-built version from https://riot.im/desktop.html or, if you prefer,
build it yourself. Requires Electron >=1.6.0
build it yourself. Requires Electron >=1.6.0.
To run as a desktop app:
@@ -233,7 +233,14 @@ for 64 bit Linux:
1. Follow the instructions in 'Building From Source' above
2. `node_modules/.bin/build -l --x64`
All electron packages go into `electron_app/dist/`
All electron packages go into `electron_app/dist/`.
Electron Specific Features
--------------------------
The electron version of Riot contains some features that are only possible from electron rather than within a browser window. This includes the "Push-to-Talk" feature, which allows you to toggle your microphone during a call even if Riot is not in focus.
This requires the use of a native node module called [iohook](https://github.com/matrix-org/iohook/). Native node modules are written in C, and by default during the build of Riot the compiled binaries will be downloaded from npm. If you would like to build this module from source yourself, please read [Compiling iohook](docs/native_node_modules.md#compiling-iohook).
Many thanks to @aviraldg for the initial work on the electron integration.