Skip to content

Commit

Permalink
add paragraph about building for linux
Browse files Browse the repository at this point in the history
addresses #15
  • Loading branch information
wojtkowiak committed Nov 13, 2016
1 parent 781dcc6 commit 4b6f3a8
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,9 +324,10 @@ To path to your extracted files is added to your module `settings` as `extracted
. So your module constructor can look like this:
```javascript
import path from 'path';
constructor({ log, skeletonApp, appSettings, eventsBus, modules, settings, Module }) {
this.pathToExe = path.join(settings.extractedFilesPath, 'dir/something.exe');
}
export default class Desktop {
constructor({ log, skeletonApp, appSettings, eventsBus, modules, settings, Module }) {
this.pathToExe = path.join(settings.extractedFilesPath, 'dir/something.exe');
}
```
## Hot code push support
Expand Down Expand Up @@ -503,10 +504,15 @@ Package is produced and saved in `.desktop-package` directory. You can pass opti
This packages and builds installer using [`electron-builder`](https://github.com/electron-userland/electron-builder).
Installer is produced and saved in `.desktop-installer` directory. You can pass options via
`builderOptions` in `settings.json`.

Please note that `electron-builder` does not use `electron-packager` to create a package. So the
options from `packagerOptions` are not taken into account.
##### Building for linux
Currently there are some defaults provided only for `Windows` and `Mac`. If you want to build for
`Linux` you need to add a [`linux`](https://github.com/electron-userland/electron-builder/wiki/Options#LinuxBuildOptions) section in your `builderOptions` and comply to these
[requirements](https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build#linux).
## Roadmap
> <sup>aka road to 1.0</sup>
Expand Down

0 comments on commit 4b6f3a8

Please sign in to comment.