electron/docs/tutorial/application-distribution.md
2014-09-29 21:34:54 +08:00

1.5 KiB

Application distribution

To distribute your app with atom-shell, you should name the folder of your app as app, and put it under atom-shell's resources directory (on OS X it is Atom.app/Contents/Resources/, and on Linux and Windows it is resources/), like this:

On Mac OS X:

atom-shell/Atom.app/Contents/Resources/app/
├── package.json
├── main.js
└── index.html

On Windows and Linux:

atom-shell/resources/app
├── package.json
├── main.js
└── index.html

Then execute Atom.app (or atom on Linux, and atom.exe on Windows), and atom-shell will start as your app. The atom-shell directory would then be your distribution that should be delivered to final users.

Packaging your app into a file

Apart from shipping your app by copying all its sources files, you can also package your app into asar archive to avoid exposing your app's source code to users.

To use the asar archive to replace the app folder, you need to rename the archive to app.asar, and put it under atom-shell's resources directory, atom-shell will then try read the archive and start from it.

More details can be found in Application packaging.

Building with grunt

If you build your application with grunt there is a grunt task that can download atom-shell for your current platform automatically: grunt-download-atom-shell.