From d9340cdc98be94239866f389827d05d82dc8659f Mon Sep 17 00:00:00 2001 From: Sean Lavine Date: Mon, 13 Jul 2015 15:24:35 -0700 Subject: [PATCH 1/2] fix typos in usage.txt --- usage.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/usage.txt b/usage.txt index de920f3490e..3ed4cca2f1d 100644 --- a/usage.txt +++ b/usage.txt @@ -1,10 +1,10 @@ Usage - $ electron-builder --plattform= --config= --out= + $ electron-builder --platform= --config= --out= Required options: platform: win, osx config: path to config file Optional options: - out: path to output the installer + out: path to output the installer (path must exist) From 129df0cea9a7fa75c17fb9feede87d4d10de9bff Mon Sep 17 00:00:00 2001 From: Sean Lavine Date: Tue, 14 Jul 2015 04:35:42 -0700 Subject: [PATCH 2/2] readme: formatting and typo fixes --- README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2bba2ba4bd2..123bb4fae85 100644 --- a/README.md +++ b/README.md @@ -27,15 +27,13 @@ $ npm install --save electron-builder After that you can easily use the `electron-builder` binary in your `npm scripts`. -``` part of package.json - +```js { "scripts" : { "pack:osx": "npm run build:osx && electron-builder \"dist/osx/Loopline Systems.app\" --platform=osx --out=\"dist/osx\" --config=packager.json" } } - ``` ## Pre-requisites @@ -78,23 +76,22 @@ $ electron-builder dist/win/someFancy-win32 --platform=win --out=/some/path/ --c ``` Usage - $ electron-builder --plattform= --config= --out= + $ electron-builder --platform= --config= --out= Required options: platform: win, osx config: path to config file Optional options: - out: path to output the installer + out: path to output the installer (must exist) ``` Because the configuration is fairly complex we decided to go with a good old config file for now. You will find a sample config file below. -``` config.json.sample: - +```js { "osx" : { "title": "Loopline Systems", @@ -118,9 +115,8 @@ config.json.sample: When you run `npm run pack` it will create executables for the platforms Windows and OS X inside of the `dist` directory. It grabs the generated executables afterwards to create the installers out of it. -``` directory structure - +``` desktop |-- app // actual electron application | @@ -144,9 +140,8 @@ desktop ``` -``` package.json - +```js { "name": "loopline-desktop", "version": "1.0.0", @@ -176,9 +171,8 @@ package.json ``` -``` packager.json - +```js { "osx" : { "title": "Loopline Systems",