From 624ae024e245f6bfc00fd1ad03f063cc40fe069c Mon Sep 17 00:00:00 2001 From: NoxFly <32705400+NoxFly@users.noreply.github.com> Date: Wed, 27 Sep 2023 01:56:39 +0200 Subject: [PATCH] docs: Quick Start | Electron Forge chapter requirements updated (#39639) * 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 --------- Co-authored-by: Erick Zhao --- docs/tutorial/quick-start.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index 30c5b47df48d..abb2629cb36d 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -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