chore: update README.md (#3025)
Co-authored-by: Erick Zhao <erick@hotmail.ca>
This commit is contained in:
Родитель
0986c7dc6e
Коммит
300387fe6a
47
README.md
47
README.md
|
@ -14,15 +14,6 @@ jump right in to Electron development.
|
|||
|
||||
---
|
||||
|
||||
## :rotating_light: :construction: **WARNING** :construction: :rotating_light:
|
||||
|
||||
:building_construction:
|
||||
|
||||
The `main` branch is a rewrite of Electron Forge that will eventually be the 6.x series. If you
|
||||
are looking for the 5.x series (the version currently published to NPM under `electron-forge`), please view the [5.x branch](https://github.com/electron/forge/tree/5.x).
|
||||
|
||||
---
|
||||
|
||||
[Website](https://www.electronforge.io) |
|
||||
[Goals](#project-goals) |
|
||||
[Docs and Usage](#docs-and-usage) |
|
||||
|
@ -31,9 +22,18 @@ are looking for the 5.x series (the version currently published to NPM under `el
|
|||
[Contributing](https://github.com/electron/forge/blob/main/CONTRIBUTING.md) |
|
||||
[Changelog](https://github.com/electron/forge/blob/main/CHANGELOG.md)
|
||||
|
||||
---
|
||||
|
||||
_Note: The major version bump between v5.0.0 and v6.0.0 contains major breaking API changes and improvements. If you are new to Forge, we highly recommend using the latest version. If using an older version of Forge, we recommend upgrading to v6.0.0 or later._
|
||||
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
**Note**: Electron Forge requires Node 12.13.0 (LTS) or above, plus git installed.
|
||||
Pre-requisities:
|
||||
|
||||
- Node 14.17.5 or higher
|
||||
- Git
|
||||
|
||||
If you have a more recent version of `npm` or `yarn`, you can use
|
||||
[`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b),
|
||||
|
@ -59,6 +59,13 @@ cd my-new-app
|
|||
npm start
|
||||
```
|
||||
|
||||
For more information on creating a new project from a template, [see our CLI documentation](https://www.electronforge.io/cli).
|
||||
|
||||
# Docs and Usage
|
||||
|
||||
For Electron Forge documentation and usage you should check out our website:
|
||||
[electronforge.io](https://www.electronforge.io)
|
||||
|
||||
# Project Goals
|
||||
|
||||
1. Starting with Electron should be as simple as a single command.
|
||||
|
@ -77,21 +84,11 @@ With these goals in mind, under the hood this project uses, among others:
|
|||
- [Electron Packager](https://github.com/electron/electron-packager):
|
||||
Customizes and bundles your Electron app to get it ready for distribution.
|
||||
|
||||
# Docs and Usage
|
||||
## Contributing
|
||||
|
||||
For Electron Forge documentation and usage you should check out our website:
|
||||
[electronforge.io](https://www.electronforge.io)
|
||||
If you are interested in reporting/fixing issues and contributing directly to the code base, please see [CONTRIBUTING.md](https://github.com/electron/forge/blob/main/CONTRIBUTING.md) for more information on what we're looking for and how to get started.
|
||||
|
||||
# FAQ
|
||||
## Community
|
||||
|
||||
## How do I use this with `webpack`/`babel`/other build tool?
|
||||
|
||||
By default, Electron Forge only runs vanilla (i.e., non-compiled) JavaScript, but for webpack and other build tooling support check out the [plugins](https://www.electronforge.io/config/plugins)
|
||||
section of our docs site. We currently have plugins for Webpack and Electron Compile, and a
|
||||
[template for Webpack](https://www.electronforge.io/templates/webpack-template).
|
||||
|
||||
# Team
|
||||
|
||||
| <img src="https://s.gravatar.com/avatar/1576c987b53868acf73d6ccb08110a78?s=144" width="144" /> | <img src="https://avatars2.githubusercontent.com/u/11417?s=460&v=4" width="144" /> |
|
||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| [Samuel Attard](https://samuelattard.com) | [Mark Lee](https://github.com/malept) |
|
||||
Please report bugs or feature requests in our [issue tracker](https://github.com/electron/forge/issues).
|
||||
You can find help for debugging your Electron Forge on the [Support page](https://github.com/electron/forge/blob/main/SUPPORT.md), and ask questions in the [official Electron Discord server](https://discord.gg/invite/APGC3k5yaH), where there is a dedicated channel for Electron Forge.
|
||||
|
|
Загрузка…
Ссылка в новой задаче