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

docs: Lead with packaging tools on distribution page (#17639)

Browse source 
* Lead with packaging tools on distribution page

* fix trailing whitespace
This commit is contained in:
Kilian Valkhof 2019-04-02 22:45:35 +02:00 • committed by Samuel Attard
parent 0431997c8d
commit 57dd192dcd
1 changed files with 11 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/tutorial/application-distribution.md
View file

@ -1,5 +1,16 @@
# Application Distribution # 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 To distribute your app with Electron, you need to download Electron's [prebuilt
binaries](https://github.com/electron/electron/releases). Next, the folder binaries](https://github.com/electron/electron/releases). Next, the folder
containing your app should be named `app` and placed in Electron's resources 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. 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 ## Rebranding by Rebuilding Electron from Source
It is also possible to rebrand Electron by changing the product name and It is also possible to rebrand Electron by changing the product name and