From 622a4e78e286b8219ef9b95101e1fa852471865a Mon Sep 17 00:00:00 2001 From: Brandon Bayer Date: Mon, 29 Aug 2016 17:32:06 -0500 Subject: [PATCH] doc: add platform specific build dependencies for electron (#660) These are all taken from: https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 43 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f38b9141..6ab6b8d2 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,11 @@ $ brew cask install hyperterm ## Contribute -1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device -2. Install the dependencies: `npm install` -3. Build the code and watch for changes: `npm run dev` -4. In a new tab, start the application: `npm start` +1. Install platform specific build dependencies [as detailed below](#required-build-dependencies) +2. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device +3. Install the dependencies: `npm install` +4. Build the code and watch for changes: `npm run dev` +5. In a new tab, start the application: `npm start` If you want to build the binaries for all specified platforms, run the command: @@ -32,6 +33,44 @@ $ npm run pack After that, you'll see the binaries in the `./dist` folder! +### Required Build Dependencies + +#### To Build on OSX: + +For Linux: +```bash +$ brew install gnu-tar libicns graphicsmagick xz +``` + +For Windows: +```bash +$ brew install wine --without-x11 +$ brew install mono +``` + +#### To Build on Linux: + +For Linux: +```bash +$ sudo apt-get install --no-install-recommends -y icnsutils graphicsmagick xz-utils +``` + +For Windows: + +* Install Wine (1.8+ is required): +```bash +$ sudo add-apt-repository ppa:ubuntu-wine/ppa -y +$ sudo apt-get update +$ sudo apt-get install --no-install-recommends -y wine1.8 +``` +* Install [Mono](http://www.mono-project.com/docs/getting-started/install/linux/#usage) (4.2+ is required): +```bash +sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF +echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list +sudo apt-get update +sudo apt-get install --no-install-recommends -y mono-devel ca-certificates-mono +``` + ## Related Repositories - [Art](https://github.com/zeit/hyperterm-art)