Skip to content

Commit 69821cd

Browse files
committed
📝 Separate the application distribution chapter out.
1 parent 98a49fa commit 69821cd

File tree

3 files changed

+38
-19
lines changed

3 files changed

+38
-19
lines changed

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Tutorials
44

55
* [Quick start](tutorial/quick-start.md)
6+
* [Application distribution](tutorial/application-distribution.md)
67
* [Use native node modules](tutorial/use-native-node-modules.md)
78

89
## Development
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Application distribution
2+
3+
To distribute your app with atom-shell, you should name the folder of your app
4+
as `app`, and put it under atom-shell's resources directory (on OS X it is
5+
`Atom.app/Contents/Resources/`, and on Linux and Windows it is `resources/`),
6+
like this:
7+
8+
On Mac OS X:
9+
10+
```text
11+
atom-shell/Atom.app/Contents/Resources/app/
12+
├── package.json
13+
├── main.js
14+
└── index.html
15+
```
16+
17+
On Windows and Linux:
18+
19+
```text
20+
atom-shell/resources/app
21+
├── package.json
22+
├── main.js
23+
└── index.html
24+
```
25+
26+
Then execute `Atom.app` (or `atom` on Linux, and `atom.exe` on Window), and
27+
atom-shell will start as your app. The `atom-shell` directory would then be
28+
your distribution that should be delivered to final users.
29+
30+
## Build with grunt
31+
32+
If you build your application with `grunt`, then there is a grunt task that can
33+
download atom-shell for current platform automatically:
34+
[grunt-download-atom-shell](https://github.com/atom/grunt-download-atom-shell).

docs/tutorial/quick-start.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,9 @@ Finally the `index.html` is the web page you want to show:
124124
## Run your app
125125

126126
After done writing your app, you could create a distribution of your app by
127-
following next section and then execute the packaged binary, or you can just
128-
use the downloaded atom-shell binary to execute your app.
127+
following the [Application distribution](./application-distribution.md) guide
128+
and then execute the packaged app, or you can just use the downloaded atom-shell
129+
binary to execute your app directly.
129130

130131
On Window:
131132

@@ -144,20 +145,3 @@ On Mac OS X:
144145
```bash
145146
$ ./Atom.app/Contents/MacOS/Atom app
146147
```
147-
148-
## Distribute your app
149-
150-
To distribute your app with atom-shell, you should name the folder of your app
151-
as `app`, and put it under atom-shell's resources directory (on OS X it is
152-
`Atom.app/Contents/Resources/`, and on Linux and Windows it is `resources/`),
153-
like this:
154-
155-
```text
156-
Atom.app/Contents/Resources/app/
157-
├── package.json
158-
├── main.js
159-
└── index.html
160-
```
161-
162-
Then execute `Atom.app` (or `atom` on Linux, and `atom.exe` on Window), and
163-
atom-shell will start as your app.

0 commit comments

Comments
 (0)