From 28b17d0ec3fb4d39e848c0b13fcd7ad261a60c9a Mon Sep 17 00:00:00 2001 From: David Baker Date: Mon, 17 Feb 2020 20:25:10 +0000 Subject: [PATCH] More doc --- README | 9 +++++++++ package.json | 1 + 2 files changed, 10 insertions(+) diff --git a/README b/README index 14cea3d..3a87a1a 100644 --- a/README +++ b/README @@ -59,12 +59,21 @@ This will do a couple of things: * Run electron-builder to build a package. The package built will match the operating system you're running the build process on. +If you'd like to build the native modules (for searching in encrypted rooms): +This will take 10 minutes or so, and will require a number of native tools +to be installed, depending on your OS (eg. rust, tcl, make/nmake). +``` +yarn run build:native +``` + You can also build using docker, which will always produce the linux package: ``` # Run this once to make the docker image yarn run docker:setup yarn run docker:install +# if you want to build the native modules (this will take a while) +yarn run docker:buildnative yarn run docker:build ``` diff --git a/package.json b/package.json index b95634a..4db1665 100644 --- a/package.json +++ b/package.json @@ -18,6 +18,7 @@ "start": "electron .", "lint": "eslint src/ scripts/ hak/", "build": "yarn run setversion && electron-builder", + "buildnative": "yarn run hak", "docker:setup": "docker build -t riot-desktop-dockerbuild dockerbuild", "docker:buildnative": "scripts/in-docker.sh yarn run hak", "docker:build": "scripts/in-docker.sh yarn run build",