mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: Quick Start | Electron Forge chapter requirements updated (#39639)

Browse source 
* Update quick-start.md

Added a note to a pre-require of Electron Forge.
Otherwise users will have an error `Cannot make for rpm, the following external binaries need to be installed: rpmbuild`

* Add two required steps for Electron Forge to build without errors

* Update docs/tutorial/quick-start.md

Co-authored-by: Erick Zhao <erick@hotmail.ca>

---------

Co-authored-by: Erick Zhao <erick@hotmail.ca>
This commit is contained in:
NoxFly 2023-09-27 01:56:39 +02:00 • committed by GitHub
commit 624ae024e2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/tutorial/quick-start.md
View file

@ -459,7 +459,14 @@ To summarize all the steps we've done:
The fastest way to distribute your newly created app is using
[Electron Forge](https://www.electronforge.io).
1. Add Electron Forge as a development dependency of your app, and use its `import` command to set up
:::info
To build an RPM package for Linux, you will need to [install its required system dependencies](https://www.electronforge.io/config/makers/rpm).
:::
1. Add a description to your `package.json` file, otherwise rpmbuild will fail. Blank description are not valid.
2. Add Electron Forge as a development dependency of your app, and use its `import` command to set up
Forge's scaffolding:
```sh npm2yarn
@ -478,7 +485,7 @@ Forge's scaffolding:
Thanks for using "electron-forge"!!!
```
2. Create a distributable using Forge's `make` command:
3. Create a distributable using Forge's `make` command:
```sh npm2yarn
npm run make