Skip to content

Commit

Permalink
Update Module Structure section of readme (#526)
Browse files Browse the repository at this point in the history
  • Loading branch information
jhen0409 authored Nov 8, 2016
1 parent 7e5b37f commit d5973a7
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,9 +160,8 @@ See [electron-builder CLI Usage](https://github.com/electron-userland/electron-b

This boilerplate uses a [two package.json structure](https://github.com/electron-userland/electron-builder#two-packagejson-structure).

#### Building windows apps from non-windows platforms
1. If the module is native to a platform or otherwise should be included with the published package (i.e. bootstrap, openbci), it should be listed under `dependencies` in `./app/package.json`.
2. If a module is `import`ed by another module, include it in `dependencies` in `./package.json`. See [this ESLint rule](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md)
1. If the module is native to a platform or otherwise should be included with the published package (i.e. bcrypt, openbci), it should be listed under `dependencies` in `./app/package.json` and `externals` in `webpack.config.base.js`. See [Externals](#externals).
2. If a module is `import`ed by another module, include it in `dependencies` in `./package.json`. See [this ESLint rule](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md).
3. Otherwise, modules used for building, testing and debugging should be included in `devDependencies` in `./package.json`.

## Static Type Checking
Expand Down

0 comments on commit d5973a7

Please sign in to comment.