electron/README.md

23 lines
922 B
Markdown
Raw Normal View History

2014-05-05 21:19:16 +00:00
# Atom Shell [![Build Status](https://travis-ci.org/atom/atom-shell.svg?branch=master)](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
using JavaScript, HTML and CSS. It is based on [node.js](http://nodejs.org) and
[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
2014-05-06 18:34:02 +00:00
Prebuilt binaries of atom-shell for Linux, Windows and Mac can be found on the
2014-05-05 18:56:35 +00:00
[releases](https://github.com/atom/atom-shell/releases) page.
2013-04-12 01:46:58 +00:00
2014-05-05 18:56:35 +00:00
## Documentation
2013-04-12 01:46:58 +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.