electron/docs-translations/zh-CN/project/README.md

85 lines
3.9 KiB
Markdown
Raw Normal View History

2016-09-02 06:25:56 +00:00
[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/)
[![Travis Build Status](https://travis-ci.org/electron/electron.svg?branch=master)](https://travis-ci.org/electron/electron)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/kvxe4byi7jcxbe26/branch/master?svg=true)](https://ci.appveyor.com/project/Atom/electron)
[![devDependency Status](https://david-dm.org/electron/electron/dev-status.svg)](https://david-dm.org/electron/electron#info=devDependencies)
[![Join the Electron Community on Slack](http://atom-slack.herokuapp.com/badge.svg)](http://atom-slack.herokuapp.com/)
Electron框架让您可使用JavaScript, HTML 及 CSS 编写桌面程序。
2016-12-29 13:53:53 +00:00
它是基于[Node.js](https://nodejs.org/)和[Chromium](http://www.chromium.org)开发的,
[Atom editor](https://github.com/atom/atom)以及很多其他的[apps](http://electron.atom.io/apps)就是使用Electron编写的。
2016-09-02 06:25:56 +00:00
请关注Twitter [@ElectronJS](https://twitter.com/electronjs) 以获得重要通告。
2016-09-02 06:25:56 +00:00
这个项目将坚持贡献者盟约 [code of conduct](CODE_OF_CONDUCT.md).
2016-12-29 13:53:53 +00:00
我们希望贡献者能遵守贡献者盟约如果发现有任何不能接受的行为请报告至electron@github.com(PS:请用英语)
2016-09-02 06:25:56 +00:00
## 下载
2016-12-30 14:50:44 +00:00
可以使用[`npm`](https://docs.npmjs.com/)来安装Electron的预编译二进制版本:
2016-09-02 06:25:56 +00:00
```sh
2016-12-30 14:50:44 +00:00
# 开发依赖安装
2016-09-02 06:25:56 +00:00
npm install electron --save-dev
2016-12-30 14:50:44 +00:00
# 全局安装
npm install electron -g
2016-09-02 06:25:56 +00:00
```
2016-12-30 14:50:44 +00:00
可以在[releases](https://github.com/electron/electron/releases)找到预编译的二进制版本及symbols调试版本
其中包括Linux,Windows和macOS版本。
2016-09-02 06:25:56 +00:00
### 其他源
- [中国](https://npm.taobao.org/mirrors/electron)
2016-09-02 06:25:56 +00:00
2016-12-30 14:50:44 +00:00
```sh
# PS:大陆到Electron源的下载速度极不稳定无法下载成功时可用
# 淘宝源开发依赖安装
ELECTRON_MIRROR=http://npm.taobao.org/mirrors/electron/ npm install electron --save-dev
# 淘宝源全局安装
ELECTRON_MIRROR=http://npm.taobao.org/mirrors/electron/ npm install electron -g
```
2016-09-02 06:25:56 +00:00
## 文档
开发指南及API文档位于
[docs](https://github.com/electron/electron/tree/master/docs)
它也包括如何编译和改进Electron
## 翻译版文档
- [葡萄牙语-巴西](https://github.com/electron/electron/tree/master/docs-translations/pt-BR)
- [韩语](https://github.com/electron/electron/tree/master/docs-translations/ko-KR)
- [日语](https://github.com/electron/electron/tree/master/docs-translations/jp)
- [西班牙语](https://github.com/electron/electron/tree/master/docs-translations/es)
- [简体中文](https://github.com/electron/electron/tree/master/docs-translations/zh-CN)
- [繁体中文](https://github.com/electron/electron/tree/master/docs-translations/zh-TW)
- [土耳其](https://github.com/electron/electron/tree/master/docs-translations/tr-TR)
- [乌克兰](https://github.com/electron/electron/tree/master/docs-translations/uk-UA)
- [俄语](https://github.com/electron/electron/tree/master/docs-translations/ru-RU)
- [法语](https://github.com/electron/electron/tree/master/docs-translations/fr-FR)
## 快速开始
2016-12-29 13:53:53 +00:00
克隆并运行这个 [`electron/electron-quick-start`](https://github.com/electron/electron-quick-start)
库来体验一个最小的 Electron 程序是怎么样的。
2016-09-02 06:25:56 +00:00
## 社区
2016-12-29 13:53:53 +00:00
你可以在以下社区提出问题以及相互交流:
- [`electron`](http://discuss.atom.io/c/electron) Atom论坛上的一类。
2016-09-02 06:25:56 +00:00
- `#atom-shell` Freenode上的聊天频道
- [`Atom`](http://atom-slack.herokuapp.com/) Slack上的频道
- [`electron-br`](https://electron-br.slack.com) *(葡萄牙语-巴西)*
- [`electron-kr`](http://www.meetup.com/electron-kr/) *(韩语)*
2016-09-02 06:25:56 +00:00
- [`electron-jp`](https://electron-jp-slackin.herokuapp.com/) *(日语)*
- [`electron-tr`](http://www.meetup.com/Electron-JS-Istanbul/) *(土耳其)*
- [`electron-id`](https://electron-id.slack.com) *(印度尼西亚)*
查看 [awesome-electron](https://github.com/sindresorhus/awesome-electron)
2016-12-29 13:53:53 +00:00
来获得由社区维护的示例程序,工具和资源列表。
## 执照
MIT © 2016 Github