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