diff options
Diffstat (limited to 'node_modules/electron/README.md')
-rw-r--r-- | node_modules/electron/README.md | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/node_modules/electron/README.md b/node_modules/electron/README.md new file mode 100644 index 0000000..c8c1376 --- /dev/null +++ b/node_modules/electron/README.md @@ -0,0 +1,115 @@ +[![Electron Logo](https://electronjs.org/images/electron-logo.svg)](https://electronjs.org) + +[![CircleCI Build Status](https://circleci.com/gh/electron/electron/tree/main.svg?style=shield)](https://circleci.com/gh/electron/electron/tree/main) +[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/4lggi9dpjc1qob7k/branch/main?svg=true)](https://ci.appveyor.com/project/electron-bot/electron-ljo26/branch/main) +[![Electron Discord Invite](https://img.shields.io/discord/745037351163527189?color=%237289DA&label=chat&logo=discord&logoColor=white)](https://discord.gg/electronjs) + +:memo: Available Translations: π¨π³ π§π· πͺπΈ π―π΅ π·πΊ π«π· πΊπΈ π©πͺ. +View these docs in other languages on our [Crowdin](https://crowdin.com/project/electron) project. + +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/main/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). + +## Platform support + +Each Electron release provides binaries for macOS, Windows, and Linux. + +* macOS (High Sierra and up): Electron provides 64-bit Intel and ARM binaries for macOS. Apple Silicon support was added in Electron 11. +* Windows (Windows 10 and up): Electron provides `ia32` (`x86`), `x64` (`amd64`), and `arm64` binaries for Windows. Windows on ARM support was added in Electron 5.0.8. Support for Windows 7, 8 and 8.1 was [removed in Electron 23, in line with Chromium's Windows deprecation policy](https://www.electronjs.org/blog/windows-7-to-8-1-deprecation-notice). +* Linux: The prebuilt binaries of Electron are built on Ubuntu 20.04. They have also been verified to work on: + * Ubuntu 14.04 and newer + * Fedora 24 and newer + * Debian 8 and newer + +## 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 + +## 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://npmmirror.com/mirrors/electron/) + +See the [Advanced Installation Instructions](https://www.electronjs.org/docs/latest/tutorial/installation#mirror) to learn how to use a custom mirror. + +## Documentation translations + +We crowdsource translations for our documentation via [Crowdin](https://crowdin.com/project/electron). +We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, +Russian, and Spanish. + +## 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 on the [Community page](https://www.electronjs.org/community). + +## License + +[MIT](https://github.com/electron/electron/blob/main/LICENSE) + +When using Electron logos, make sure to follow [OpenJS Foundation Trademark Policy](https://openjsf.org/wp-content/uploads/sites/84/2021/01/OpenJS-Foundation-Trademark-Policy-2021-01-12.docx.pdf). |