mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Max Ogden 2014-10-20 13:36:12 +09:00
parent 7e2ce00b21
commit 0d2b614506
1 changed files with 30 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
npm/README.md
View file

@ -1,8 +1,35 @@
# atom-shell
Install [atom-shell](https://github.com/atom/atom-shell) prebuilts using npm
Install [atom-shell](https://github.com/atom/atom-shell) prebuilt binaries for command-line use using npm. Works on Mac, Windows and Linux.
Atom Shell is a javascript runtime that bundles Node.js and Chromium. You use it similar to the `node` command on the command line for executing javascript programs. This module helps you easily install the `atom-shell` command for use on the command line without having to compile anything.
## Installation
Download and install the latest build of atom-shell for your OS and symlink it into your PATH:
```
npm install -g atom-shell
atom-shell # will open atom shell
```
```
If that command fails with an `EACCESS` error you may have to run it again with `sudo`:
```
sudo npm install -g atom-shell
```
Now you can just run `atom-shell` to run atom-shell:
```
atom-shell
```
## Usage
First you have to [write an atom shell application](https://github.com/atom/atom-shell/blob/master/docs/tutorial/quick-start.md#write-your-first-atom-shell-app)
Then you can run your app using:
```
atom-shell your-app/
```