Standardize app dist

This commit is contained in:
Jessica Lord 2015-08-31 19:10:29 -07:00
parent b205bd381e
commit e0a57a0a47

View file

@ -1,9 +1,9 @@
# Application distribution
# Application Distribution
To distribute your app with Electron, you should name the folder of your app
as `app`, and put it under Electron's resources directory (on OS X it is
`Electron.app/Contents/Resources/`, and on Linux and Windows it is
`resources/`), like this:
To distribute your app with Electron, the folder containing your app should be
named `app` and placed under Electron's resources directory (on OS X it is
`Electron.app/Contents/Resources/` and on Linux and Windows it is `resources/`),
like this:
On OS X:
@ -24,12 +24,12 @@ electron/resources/app
```
Then execute `Electron.app` (or `electron` on Linux, `electron.exe` on Windows),
and Electron will start as your app. The `electron` directory would then be
your distribution that should be delivered to final users.
and Electron will start as your app. The `electron` directory will then be
your distribution to deliver to final users.
## Packaging your app into a file
## Packaging Your App into a File
Apart from shipping your app by copying all its sources files, you can also
Apart from shipping your app by copying all of its source files, you can also
package your app into an [asar](https://github.com/atom/asar) archive to avoid
exposing your app's source code to users.
@ -53,7 +53,7 @@ electron/resources/
More details can be found in [Application packaging](application-packaging.md).
## Rebranding with downloaded binaries
## Rebranding with Downloaded Binaries
After bundling your app into Electron, you will want to rebrand Electron
before distributing it to users.
@ -103,7 +103,7 @@ MyApp.app/Contents
You can rename the `electron` executable to any name you like.
## 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
building it from source. To do this you need to modify the `atom.gyp` file and