Skip to content

Commit

Permalink
Merge pull request #23 from freewil/usage-typos
Browse files Browse the repository at this point in the history
fix typos in usage.txt
  • Loading branch information
stefanjudis committed Jul 14, 2015
2 parents db522e6 + 129df0c commit 02206ff
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 15 deletions.
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -78,23 +76,22 @@ $ electron-builder dist/win/someFancy-win32 --platform=win --out=/some/path/ --c

```
Usage
$ electron-builder <sourcedir> --plattform=<plattform> --config=<configPath> --out=<outputPath>
$ electron-builder <sourcedir> --platform=<platform> --config=<configPath> --out=<outputPath>
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",
Expand All @@ -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
|
Expand All @@ -144,9 +140,8 @@ desktop
```


```
package.json
```js
{
"name": "loopline-desktop",
"version": "1.0.0",
Expand Down Expand Up @@ -176,9 +171,8 @@ package.json

```

```
packager.json
```js
{
"osx" : {
"title": "Loopline Systems",
Expand Down
4 changes: 2 additions & 2 deletions usage.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@

Usage
$ electron-builder <sourcedir> --plattform=<plattform> --config=<configPath> --out=<outputPath>
$ electron-builder <sourcedir> --platform=<platform> --config=<configPath> --out=<outputPath>

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)

0 comments on commit 02206ff

Please sign in to comment.