From dc74ad5d13edda7cffc976a4539854fe9cd287ad Mon Sep 17 00:00:00 2001 From: whphhg Date: Sun, 21 May 2017 15:48:52 +0200 Subject: [PATCH] README: Update with macOS packaging, minor changes --- README.md | 26 +++++++++++++++++++------- bin/README.md | 2 +- package.json | 5 +++-- src/electron.js | 14 ++------------ src/stores/rpc.js | 8 +------- 5 files changed, 26 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 5f2a6f4..06cf855 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,7 @@ using `npm run dev` or `npm run dev-win` on Windows. $ npm run dev (Linux and macOS) $ npm run dev-win (Windows) -## Package and build for Linux and Windows -The following dependencies are required to be installed: -* docker (make sure your user is in the docker group) - +## Package and build To bundle the daemon with the GUI, name it `vcashd-arch`, where `arch` can be either `ia32` or `x64` and place it into the `bin` directory. This directory is checked for the current platform & arch daemon executable on start-up by @@ -46,6 +43,10 @@ actually packaging the GUI run `npm run pack`. $ npm run pack +### Linux and Windows (using Docker) +The following dependencies are required to be installed: +* docker (make sure your user is in the docker group) + Run the docker container. $ docker run --rm -ti -v ${PWD}:/project -v ${PWD##*/}-node-modules:/project/node_modules -v ~/.electron:/root/.electron electronuserland/electron-builder:wine @@ -68,12 +69,23 @@ dist-win32-x64 | x64 | Create a 64-bit Windows portable executable `vcashd-ia32.exe` and `vcashd-x64.exe` in the `bin` directory. Other scripts require only the daemon for the target arch of the platform they're packaging for. +## Linux and macOS +To package in a distributable format run one of the scripts from the table +below, which will create the packages for your current platform and save +them into the `dist` directory. Packages will be created according to the +`build` and `scripts` options in +[package.json](https://github.com/whphhg/vcash-electron/blob/master/package.json#L11-L33). + + $ npm run