From 8dc95ab23bd78ec07897a797feb5152c76d56671 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 9 Apr 2019 17:57:16 +0100 Subject: [PATCH] Update docs with build deps --- docs/native_node_modules.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/native_node_modules.md b/docs/native_node_modules.md index 2431346e..7a565cb4 100644 --- a/docs/native_node_modules.md +++ b/docs/native_node_modules.md @@ -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