|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104 |
- [![Electron Logo](https://electronjs.org/images/electron-logo.svg)](https://electronjs.org)
-
- [![CircleCI Build Status](https://circleci.com/gh/electron/electron/tree/master.svg?style=shield)](https://circleci.com/gh/electron/electron/tree/master)
- [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/4lggi9dpjc1qob7k/branch/master?svg=true)](https://ci.appveyor.com/project/electron-bot/electron-ljo26/branch/master)
- [![devDependency Status](https://david-dm.org/electron/electron/dev-status.svg)](https://david-dm.org/electron/electron?type=dev)
- [![Electron Discord Invite](https://img.shields.io/discord/745037351163527189?color=%237289DA&label=chat&logo=discord&logoColor=white)](https://discord.com/invite/electron)
-
- :memo: Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪.
- View these docs in other languages at [electron/i18n](https://github.com/electron/i18n/tree/master/content/).
-
- 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](https://www.chromium.org) and is used by the [Atom
- editor](https://github.com/atom/atom) and many other [apps](https://electronjs.org/apps).
-
- Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important
- announcements.
-
- This project adheres to the Contributor Covenant
- [code of conduct](https://github.com/electron/electron/tree/master/CODE_OF_CONDUCT.md).
- By participating, you are expected to uphold this code. Please report unacceptable
- behavior to [coc@electronjs.org](mailto:coc@electronjs.org).
-
- ## Installation
-
- To install prebuilt Electron binaries, use [`npm`](https://docs.npmjs.com/).
- The preferred method is to install Electron as a development dependency in your
- app:
-
- ```sh
- npm install electron --save-dev
- ```
-
- For more installation options and troubleshooting tips, see
- [installation](docs/tutorial/installation.md). For info on how to manage Electron versions in your apps, see
- [Electron versioning](docs/tutorial/electron-versioning.md).
-
- ## Quick start & Electron Fiddle
-
- Use [`Electron Fiddle`](https://github.com/electron/fiddle)
- to build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and
- to try out different versions of Electron. It's designed to make the start of your journey with
- Electron easier.
-
- Alternatively, clone and run the
- [electron/electron-quick-start](https://github.com/electron/electron-quick-start)
- repository to see a minimal Electron app in action:
-
- ```sh
- git clone https://github.com/electron/electron-quick-start
- cd electron-quick-start
- npm install
- npm start
- ```
-
- ## Resources for learning Electron
-
- - [electronjs.org/docs](https://electronjs.org/docs) - All of Electron's documentation
- - [electron/fiddle](https://github.com/electron/fiddle) - A tool to build, run, and package small Electron experiments
- - [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - A very basic starter Electron app
- - [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - Sample starter apps created by the community
- - [electron/simple-samples](https://github.com/electron/simple-samples) - Small applications with ideas for taking them further
- - [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - An Electron app that teaches you how to use Electron
- - [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - Small demo apps for the various Electron APIs
-
- ## Programmatic usage
-
- Most people use Electron 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
- binary. Use this to spawn Electron from Node scripts:
-
- ```javascript
- const electron = require('electron')
- const proc = require('child_process')
-
- // will print something similar to /Users/maf/.../Electron
- console.log(electron)
-
- // spawn Electron
- const child = proc.spawn(electron)
- ```
-
- ### Mirrors
-
- - [China](https://npm.taobao.org/mirrors/electron)
-
- ## Documentation Translations
-
- Find documentation translations in [electron/i18n](https://github.com/electron/i18n).
-
- ## Contributing
-
- If you are interested in reporting/fixing issues and contributing directly to the code base, please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.
-
- ## Community
-
- Info on reporting bugs, getting help, finding third-party tools and sample apps,
- and more can be found in the [support document](docs/tutorial/support.md#finding-support).
-
- ## 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).
|