mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Merge pull request #177 from electron-userland/readme-cleanup

Browse source 
Cleanup README
This commit is contained in:
Mark Lee 2016-08-09 11:56:58 -07:00 committed by GitHub
commit eef534259f
1 changed files with 41 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
npm/README.md
View file

@ -4,11 +4,14 @@
[![badge](https://nodei.co/npm/electron-prebuilt.png?downloads=true)](https://www.npmjs.com/package/electron-prebuilt) [![badge](https://nodei.co/npm/electron-prebuilt.png?downloads=true)](https://www.npmjs.com/package/electron-prebuilt)
Install [electron](https://github.com/electron/electron) prebuilt binaries for command-line use using npm. This module helps you easily install the `electron` command for use on the command line without having to compile anything. Install [Electron](https://github.com/electron/electron) prebuilt binaries for
command-line use using npm. This module helps you easily install the `electron`
command for use on the command line without having to compile anything.
[Electron](http://electron.atom.io) is a JavaScript runtime that bundles Node.js [Electron](http://electron.atom.io) is a JavaScript runtime that bundles Node.js
and Chromium. You use it similar to the `node` command on the command line for and Chromium. You use it similar to the `node` command on the command line for
executing JavaScript programs. For more info you can read [this intro blog post](http://maxogden.com/electron-fundamentals.html) or dive into the [Electron documentation](http://electron.atom.io/docs) executing JavaScript programs. For more info you can read [this intro blog post](http://maxogden.com/electron-fundamentals.html)
or dive into the [Electron documentation](http://electron.atom.io/docs).
## Installation ## Installation
@ -17,80 +20,92 @@ executing JavaScript programs. For more info you can read [this intro blog post]
`electron` is recommended, as the `electron-prebuilt` name is deprecated, and `electron` is recommended, as the `electron-prebuilt` name is deprecated, and
will only be published until the end of 2016. will only be published until the end of 2016.
Download and install the latest build of electron for your OS and add it to your Download and install the latest build of Electron for your OS and add it to your
project's `package.json` as a `devDependency`: project's `package.json` as a `devDependency`:
``` ```shell
npm install electron --save-dev npm install electron --save-dev
``` ```
This is the preferred way to use electron, as it doesn't require users to This is the preferred way to use Electron, as it doesn't require users to
install electron globally. install Electron globally.
You can also use the `-g` flag (global) to symlink it into your PATH: You can also use the `-g` flag (global) to symlink it into your PATH:
``` ```shell
npm install -g electron npm install -g electron
``` ```
If that command fails with an `EACCESS` error you may have to run it again with `sudo`: If that command fails with an `EACCESS` error you may have to run it again with `sudo`:
``` ```shell
sudo npm install -g electron sudo npm install -g electron
``` ```
Now you can just run `electron` to run electron: Now you can just run `electron` to run electron:
``` ```shell
electron electron
``` ```
If you need to use an HTTP proxy you can [set these environment variables](https://github.com/request/request/tree/f0c4ec061141051988d1216c24936ad2e7d5c45d#controlling-proxy-behaviour-using-environment-variables) If you need to use an HTTP proxy you can [set these environment variables](https://github.com/request/request/tree/f0c4ec061141051988d1216c24936ad2e7d5c45d#controlling-proxy-behaviour-using-environment-variables).
If you want to change the architecture that is downloaded (e.g., `ia32` on an `x64` machine), you can use the `--arch` flag with npm install or set the `npm_config_arch` environment variable: If you want to change the architecture that is downloaded (e.g., `ia32` on an
``` `x64` machine), you can use the `--arch` flag with npm install or set the
`npm_config_arch` environment variable:
```shell
npm install --arch=ia32 electron npm install --arch=ia32 electron
``` ```
## About ## About
Works on Mac, Windows and Linux OSes that Electron supports (e.g. Electron [does not support Windows XP](https://github.com/electron/electron/issues/691)). Works on Mac, Windows and Linux OSes that Electron supports (e.g. Electron
[does not support Windows XP](https://github.com/electron/electron/issues/691)).
The version numbers of this module match the version number of the [offical Electron releases](https://github.com/electron/electron/releases), which do not follow [semantic versioning](http://semver.org/). The version numbers of this module match the version number of the [official
Electron releases](https://github.com/electron/electron/releases), which
[do not follow semantic versioning](http://electron.atom.io/docs/tutorial/electron-versioning/).
This module is automatically released whenever a new version of Electron is released thanks to [electron-prebuilt-updater](https://github.com/johnmuhl/electron-prebuilt-updater) written by [John Muhl](https://github.com/johnmuhl/). This module is automatically released whenever a new version of Electron is
released thanks to [electron-prebuilt-updater](https://github.com/electron/electron-prebuilt-updater),
originally written by [John Muhl](https://github.com/johnmuhl/).
## Usage ## Usage
First you have to [write an electron application](https://github.com/electron/electron/blob/master/docs/tutorial/quick-start.md) First, you have to [write an Electron application](http://electron.atom.io/docs/tutorial/quick-start/).
Then you can run your app using: Then, you can run your app using:
``` ```shell
electron your-app/ electron your-app/
``` ```
## Related modules ## Related modules
- [electron-packager](https://github.com/electron-userland/electron-packager) - package and distribute your electron app in OS executables (.app, .exe etc) - [electron-packager](https://github.com/electron-userland/electron-packager) -
- [electron-builder](https://github.com/loopline-systems/electron-builder) - create installers for Windows and OS X. It's built to work together with electron-packager Package and distribute your Electron app with OS-specific bundles
- [menubar](https://github.com/maxogden/menubar) - high level way to create menubar desktop applications with electron (.app, .exe etc)
- [electron-builder](https://github.com/electron-userland/electron-builder) -
create installers
- [menubar](https://github.com/maxogden/menubar) - high level way to create
menubar desktop applications with electron
Find more at the [awesome-electron](https://github.com/sindresorhus/awesome-electron) list Find more at the [awesome-electron](https://github.com/sindresorhus/awesome-electron) list.
## Programmatic usage ## Programmatic usage
Most people use this from the command line, but if you require `electron` inside Most people use this from the command line, but if you require `electron` inside
your **node app** (not your electron app) it will return the file path to the your **Node app** (not your Electron app) it will return the file path to the
binary. Use this to spawn electron from node scripts: binary. Use this to spawn Electron from Node scripts:
``` js ```javascript
var electron = require('electron') var electron = require('electron')
var proc = require('child_process') var proc = require('child_process')
// will something similar to print /Users/maf/.../Electron // will something similar to print /Users/maf/.../Electron
console.log(electron) console.log(electron)
// spawn electron // spawn Electron
var child = proc.spawn(electron) var child = proc.spawn(electron)
``` ```