2014-05-05 21:19:16 +00:00
|
|
|
# Atom Shell [](https://travis-ci.org/atom/atom-shell)
|
|
|
|
|
|
2014-05-05 18:56:35 +00:00
|
|
|
The Atom Shell framework lets you write cross-platform desktop applications
|
2015-03-05 21:33:02 +00:00
|
|
|
using JavaScript, HTML and CSS. It is based on [io.js](http://iojs.org) and
|
2014-05-05 18:56:35 +00:00
|
|
|
[Chromium](http://www.chromium.org) and is used in the [Atom
|
|
|
|
|
editor](https://github.com/atom/atom).
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2014-05-04 12:58:59 +00:00
|
|
|
## Downloads
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2015-03-26 07:59:07 +00:00
|
|
|
Prebuilt binaries and debug symbols of atom-shell for Linux, Windows and Mac can
|
|
|
|
|
be found on the [releases](https://github.com/atom/atom-shell/releases) page.
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2015-03-26 07:59:07 +00:00
|
|
|
You can also use [`npm`](https://docs.npmjs.com/) to install prebuilt atom-shell
|
|
|
|
|
binaries:
|
2015-02-26 05:56:47 +00:00
|
|
|
|
|
|
|
|
```
|
2015-03-01 19:58:33 +00:00
|
|
|
# Install globally in your $PATH
|
2015-02-26 05:56:47 +00:00
|
|
|
npm install atom-shell -g
|
|
|
|
|
|
2015-03-01 19:58:33 +00:00
|
|
|
# Install as a development dependency
|
2015-02-26 05:56:47 +00:00
|
|
|
npm install atom-shell --save-dev
|
|
|
|
|
```
|
|
|
|
|
|
2015-01-19 14:30:33 +00:00
|
|
|
### Mirrors
|
|
|
|
|
|
|
|
|
|
- [China Mirror](https://npm.taobao.org/mirrors/atom-shell): Improve download speeds for Chinese user.
|
|
|
|
|
|
2014-05-05 18:56:35 +00:00
|
|
|
## Documentation
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2014-05-07 05:06:35 +00:00
|
|
|
Guides and the API reference are located in the
|
2014-05-05 18:56:35 +00:00
|
|
|
[docs](https://github.com/atom/atom-shell/tree/master/docs) directory. It also
|
2014-05-06 03:13:19 +00:00
|
|
|
contains documents describing how to build and contribute to atom-shell.
|
2014-05-14 18:32:24 +00:00
|
|
|
|
|
|
|
|
## Community
|
|
|
|
|
|
|
|
|
|
There is an [`atom-shell` category on the Atom forums](http://discuss.atom.io/category/atom-shell)
|
|
|
|
|
as well as an `#atom-shell` channel on Freenode.
|
