87 lines
4.3 KiB
Markdown
87 lines
4.3 KiB
Markdown
[](http://electron.atom.io/)
|
|
|
|
[](https://travis-ci.org/electron/electron)
|
|
[](https://ci.appveyor.com/project/Atom/electron)
|
|
[](https://david-dm.org/electron/electron?type=dev)
|
|
[](http://atom-slack.herokuapp.com/)
|
|
|
|
:memo: Available Translations: [Korean](https://github.com/electron/electron/tree/master/docs-translations/ko-KR/project/README.md) | [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN/project/README.md) | [Brazilian Portuguese](https://github.com/electron/electron/tree/master/docs-translations/pt-BR/project/README.md) | [Traditional Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-TW/project/README.md)
|
|
|
|
The Electron framework lets you write cross-platform desktop applications
|
|
using JavaScript, HTML and CSS. It is based on [Node.js](https://nodejs.org/) and
|
|
[Chromium](http://www.chromium.org) and is used by the [Atom
|
|
editor](https://github.com/atom/atom) and many other [apps](http://electron.atom.io/apps).
|
|
|
|
Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important
|
|
announcements.
|
|
|
|
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
|
|
By participating, you are expected to uphold this code. Please report unacceptable
|
|
behavior to electron@github.com.
|
|
|
|
## Downloads
|
|
|
|
To install prebuilt Electron binaries, use
|
|
[`npm`](https://docs.npmjs.com/):
|
|
|
|
```sh
|
|
# Install as a development dependency
|
|
npm install electron --save-dev
|
|
|
|
# Install the `electron` command globally in your $PATH
|
|
npm install electron -g
|
|
```
|
|
|
|
See the [releases page](https://github.com/electron/electron/releases) for
|
|
prebuilt binaries, debug symbols, and more.
|
|
|
|
### Mirrors
|
|
|
|
- [China](https://npm.taobao.org/mirrors/electron)
|
|
|
|
## Documentation
|
|
|
|
Guides and the API reference are located in the
|
|
[docs](https://github.com/electron/electron/tree/master/docs) directory. It also
|
|
contains documents describing how to build and contribute to Electron.
|
|
|
|
## Documentation Translations
|
|
|
|
- [Brazilian Portuguese](https://github.com/electron/electron/tree/master/docs-translations/pt-BR)
|
|
- [Korean](https://github.com/electron/electron/tree/master/docs-translations/ko-KR)
|
|
- [Japanese](https://github.com/electron/electron/tree/master/docs-translations/jp)
|
|
- [Spanish](https://github.com/electron/electron/tree/master/docs-translations/es)
|
|
- [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN)
|
|
- [Traditional Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-TW)
|
|
- [Turkish](https://github.com/electron/electron/tree/master/docs-translations/tr-TR)
|
|
- [Ukrainian](https://github.com/electron/electron/tree/master/docs-translations/uk-UA)
|
|
- [Russian](https://github.com/electron/electron/tree/master/docs-translations/ru-RU)
|
|
- [French](https://github.com/electron/electron/tree/master/docs-translations/fr-FR)
|
|
|
|
## Quick Start
|
|
|
|
Clone and run the [`electron/electron-quick-start`](https://github.com/electron/electron-quick-start)
|
|
repository to see a minimal Electron app in action.
|
|
|
|
## Community
|
|
|
|
You can ask questions and interact with the community in the following
|
|
locations:
|
|
- [`electron`](http://discuss.atom.io/c/electron) category on the Atom
|
|
forums
|
|
- `#atom-shell` channel on Freenode
|
|
- [`Atom`](http://atom-slack.herokuapp.com/) channel on Slack
|
|
- [`electron-br`](https://electron-br.slack.com) *(Brazilian Portuguese)*
|
|
- [`electron-kr`](http://www.meetup.com/electron-kr/) *(Korean)*
|
|
- [`electron-jp`](https://electron-jp-slackin.herokuapp.com/) *(Japanese)*
|
|
- [`electron-tr`](http://www.meetup.com/Electron-JS-Istanbul/) *(Turkish)*
|
|
- [`electron-id`](https://electron-id.slack.com) *(Indonesia)*
|
|
|
|
Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron)
|
|
for a community maintained list of useful example apps, tools and resources.
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/electron/electron/blob/master/LICENSE)
|
|
|
|
When using the Electron or other GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
|