📝 Separate the application distribution chapter out.

This commit is contained in:
Cheng Zhao 2014-05-04 18:32:12 +08:00
parent 98a49fa155
commit 69821cdb96
3 changed files with 38 additions and 19 deletions

View file

@ -3,6 +3,7 @@
## Tutorials
* [Quick start](tutorial/quick-start.md)
* [Application distribution](tutorial/application-distribution.md)
* [Use native node modules](tutorial/use-native-node-modules.md)
## Development

View file

@ -0,0 +1,34 @@
# 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:
```text
atom-shell/Atom.app/Contents/Resources/app/
├── package.json
├── main.js
└── index.html
```
On Windows and Linux:
```text
atom-shell/resources/app
├── package.json
├── main.js
└── index.html
```
Then execute `Atom.app` (or `atom` on Linux, and `atom.exe` on Window), and
atom-shell will start as your app. The `atom-shell` directory would then be
your distribution that should be delivered to final users.
## Build with grunt
If you build your application with `grunt`, then there is a grunt task that can
download atom-shell for current platform automatically:
[grunt-download-atom-shell](https://github.com/atom/grunt-download-atom-shell).

View file

@ -124,8 +124,9 @@ Finally the `index.html` is the web page you want to show:
## Run your app
After done writing your app, you could create a distribution of your app by
following next section and then execute the packaged binary, or you can just
use the downloaded atom-shell binary to execute your app.
following the [Application distribution](./application-distribution.md) guide
and then execute the packaged app, or you can just use the downloaded atom-shell
binary to execute your app directly.
On Window:
@ -144,20 +145,3 @@ On Mac OS X:
```bash
$ ./Atom.app/Contents/MacOS/Atom app
```
## Distribute your app
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:
```text
Atom.app/Contents/Resources/app/
├── package.json
├── main.js
└── index.html
```
Then execute `Atom.app` (or `atom` on Linux, and `atom.exe` on Window), and
atom-shell will start as your app.