From 57dd192dcd380c87584523ab2966641e50b7f9c4 Mon Sep 17 00:00:00 2001 From: Kilian Valkhof Date: Tue, 2 Apr 2019 22:45:35 +0200 Subject: [PATCH] docs: Lead with packaging tools on distribution page (#17639) * Lead with packaging tools on distribution page * fix trailing whitespace --- docs/tutorial/application-distribution.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/tutorial/application-distribution.md b/docs/tutorial/application-distribution.md index 749bf4d94a5d..c23bf05166cc 100644 --- a/docs/tutorial/application-distribution.md +++ b/docs/tutorial/application-distribution.md @@ -1,5 +1,16 @@ # Application Distribution +To distribute your app with Electron, you need to package and rebrand it. The easiest way to do this is to use one of the following third party packaging tools: + +* [electron-forge](https://github.com/electron-userland/electron-forge) +* [electron-builder](https://github.com/electron-userland/electron-builder) +* [electron-packager](https://github.com/electron-userland/electron-packager) + +These tools will take care of all the steps you need to take to end up with a distributable Electron applications, such as packaging your application, rebranding the executable, setting the right icons and optionally creating installers. + +## Manual distribution +You can also choose to manually get your app ready for distribution. The steps needed to do this are outlined below. + To distribute your app with Electron, you need to download Electron's [prebuilt binaries](https://github.com/electron/electron/releases). Next, the folder containing your app should be named `app` and placed in Electron's resources @@ -96,15 +107,6 @@ MyApp.app/Contents You can rename the `electron` executable to any name you like. -## Packaging Tools - -Apart from packaging your app manually, you can also choose to use third party -packaging tools to do the work for you: - -* [electron-forge](https://github.com/electron-userland/electron-forge) -* [electron-builder](https://github.com/electron-userland/electron-builder) -* [electron-packager](https://github.com/electron-userland/electron-packager) - ## Rebranding by Rebuilding Electron from Source It is also possible to rebrand Electron by changing the product name and