gaja-group
/
element-web
forked from matrix/element-web
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update docs with build deps

This commit is contained in:
Andrew Morgan 2019-04-09 17:57:16 +01:00
parent cb2141075c
commit 8dc95ab23b
1 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/native_node_modules.md
View File

@ -1,16 +1,29 @@
# Native Node Modules
Since v???, the electron version of Riot can make use of native node modules. These allow Riot to integrate with the desktop in ways that a browser cannot.
Since v???, the electron version of Riot can make use of native node modules.
These allow Riot to integrate with the desktop in ways that a browser cannot.
While handy, these modules must be compiled and are thus downloaded pre-compiled during build so that a single OS can compile Riot for all platforms. If you would like to compile the native node modules from source, as is done for Riot releases, instead of trusting binaries hosted on npm, then please read on.
While handy, these modules must be compiled and are thus downloaded
pre-compiled during build so that a single OS can compile Riot for all
platforms. If you would like to compile the native node modules from source,
as is done for Riot releases, instead of trusting binaries hosted on npm,
then please read on.
Do note that compiling a module for a particular operating system (Linux/Mac/Windows) and architecture (x64/x86) will need to be done on a system that is currently running that
Do note that compiling a module for a particular operating system
(Linux/Mac/Windows) and will need to be done on that operating system.
## Compiling iohook
[iohook](https://github.com/matrix-org/iohook/) is a native node module written in C/C++ that allows for cross-platform capturing of keystrokes. This is used for providing Push-to-Talk functionality (pressing a key to toggle the microphone in a call) and is ONLY enabled during a call and while setting the keybinding in settings.
[iohook](https://github.com/matrix-org/iohook/) is a native node module
written in C/C++ that allows for cross-platform capturing of keystrokes. This
is used for providing Push-to-Talk functionality (pressing a key to toggle
the microphone in a call) and is ONLY enabled during a call and while setting
the keybinding in settings.
If you would like to rebuild the module yourself and replace the downloaded binaries, use the following commands from Riot's root directory:
If you would like to rebuild the module yourself and replace the downloaded
binaries, then first make sure you have [iohook's
dependencies](https://wilix-team.github.io/iohook/manual-build.html#ubuntu-16)
installed. Then execute the following commands from Riot's root directory:
```bash
cd electron_app