2015-04-28 14:48:54 +00:00
|
|
|
[](http://electron.atom.io/)
|
2015-04-23 20:46:48 +00:00
|
|
|
|
2015-04-23 20:50:43 +00:00
|
|
|
[](https://travis-ci.org/atom/electron)
|
2015-04-23 21:00:40 +00:00
|
|
|
[](https://david-dm.org/atom/electron#info=devDependencies)
|
2015-06-29 23:46:22 +00:00
|
|
|
[](http://atom-slack.herokuapp.com/)
|
|
|
|
|
|
2015-09-09 18:34:20 +00:00
|
|
|
:zap: *Formerly known as Atom Shell* :zap:
|
2015-04-20 18:22:50 +00:00
|
|
|
|
2015-04-08 17:16:10 +00:00
|
|
|
The Electron framework lets you write cross-platform desktop applications
|
2015-11-03 05:16:12 +00:00
|
|
|
using JavaScript, HTML and CSS. It is based on [Node.js](https://nodejs.org/en/) and
|
2014-05-05 18:56:35 +00:00
|
|
|
[Chromium](http://www.chromium.org) and is used in the [Atom
|
|
|
|
|
editor](https://github.com/atom/atom).
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2015-04-24 00:00:04 +00:00
|
|
|
Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important
|
|
|
|
|
announcements.
|
|
|
|
|
|
2015-11-03 05:16:12 +00:00
|
|
|
This project adheres to the [Contributor Covenant 1.2](http://contributor-covenant.org/version/1/2/0/).
|
2015-10-03 05:42:34 +00:00
|
|
|
By participating, you are expected to uphold this code. Please report
|
2015-09-09 18:34:20 +00:00
|
|
|
unacceptable behavior to atom@github.com.
|
2015-07-08 20:29:24 +00:00
|
|
|
|
2014-05-04 12:58:59 +00:00
|
|
|
## Downloads
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2015-10-31 02:30:18 +00:00
|
|
|
Prebuilt binaries and debug symbols of Electron for Linux, Windows and OS X can
|
2015-04-16 03:10:24 +00:00
|
|
|
be found on the [releases](https://github.com/atom/electron/releases) page.
|
2015-02-26 05:56:47 +00:00
|
|
|
|
2015-04-17 18:25:06 +00:00
|
|
|
You can also use [`npm`](https://docs.npmjs.com/) to install prebuilt electron
|
|
|
|
|
binaries:
|
|
|
|
|
|
2015-04-29 17:56:31 +00:00
|
|
|
```sh
|
2015-04-17 18:25:06 +00:00
|
|
|
# Install the `electron` command globally in your $PATH
|
|
|
|
|
npm install electron-prebuilt -g
|
|
|
|
|
|
|
|
|
|
# Install as a development dependency
|
|
|
|
|
npm install electron-prebuilt --save-dev
|
|
|
|
|
```
|
|
|
|
|
|
2015-01-19 14:30:33 +00:00
|
|
|
### Mirrors
|
|
|
|
|
|
2015-05-10 08:15:12 +00:00
|
|
|
- [China](https://npm.taobao.org/mirrors/electron)
|
2015-01-19 14:30:33 +00:00
|
|
|
|
2014-05-05 18:56:35 +00:00
|
|
|
## Documentation
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2014-05-07 05:06:35 +00:00
|
|
|
Guides and the API reference are located in the
|
2015-04-16 03:10:24 +00:00
|
|
|
[docs](https://github.com/atom/electron/tree/master/docs) directory. It also
|
|
|
|
|
contains documents describing how to build and contribute to Electron.
|
2014-05-14 18:32:24 +00:00
|
|
|
|
2015-08-23 15:19:37 +00:00
|
|
|
## Documentation Translations
|
|
|
|
|
|
2015-09-04 14:52:27 +00:00
|
|
|
- [Brazilian Portuguese](https://github.com/atom/electron/tree/master/docs-translations/pt-BR)
|
2015-09-19 06:30:30 +00:00
|
|
|
- [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko-KR)
|
2015-08-23 15:19:37 +00:00
|
|
|
- [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp)
|
|
|
|
|
- [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es)
|
2015-08-31 03:02:37 +00:00
|
|
|
- [Simplified Chinese](https://github.com/atom/electron/tree/master/docs-translations/zh-CN)
|
2015-09-03 09:10:32 +00:00
|
|
|
- [Traditional Chinese](https://github.com/atom/electron/tree/master/docs-translations/zh-TW)
|
2015-08-23 15:19:37 +00:00
|
|
|
|
2015-10-19 22:52:02 +00:00
|
|
|
## Quick Start
|
|
|
|
|
|
|
|
|
|
Clone and run the [`atom/electron-quick-start`](https://github.com/atom/electron-quick-start)
|
|
|
|
|
repository to see a minimal Electron app in action.
|
|
|
|
|
|
2014-05-14 18:32:24 +00:00
|
|
|
## Community
|
|
|
|
|
|
2015-10-03 05:42:34 +00:00
|
|
|
You can ask questions and interact with the community in the following
|
2015-09-09 18:34:20 +00:00
|
|
|
locations:
|
2015-11-03 05:16:12 +00:00
|
|
|
- [`electron`](http://discuss.atom.io/c/electron) category on the Atom
|
2015-09-09 18:34:20 +00:00
|
|
|
forums
|
|
|
|
|
- `#atom-shell` channel on Freenode
|
|
|
|
|
- [`Atom`](http://atom-slack.herokuapp.com/) channel on Slack
|
2015-05-16 15:03:19 +00:00
|
|
|
|
2015-10-03 05:42:34 +00:00
|
|
|
Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron)
|
2015-09-09 18:34:20 +00:00
|
|
|
for a community maintained list of useful example apps, tools and resources.
|
