Skip to content

Commit

Permalink
Merge branch 'master' of github.com:appjs/appjs
Browse files Browse the repository at this point in the history
  • Loading branch information
milani committed Aug 5, 2012
2 parents dffd834 + 757e53a commit e544bba
Showing 1 changed file with 15 additions and 31 deletions.
46 changes: 15 additions & 31 deletions README.md
Expand Up @@ -5,7 +5,7 @@ AppJS is an SDK to develop desktop applications using Node.js melded with Chromi
* mature http/https servers and client APIs - Node
* filesystem, dns, cryptography, subprocesses, OS APIs - Node
* sandboxed code execution environements virtual machines - Node
* tools for exposing native C++ bindings to JavaScript--APIs for authoring and the tools for compiling - Node
* tools for exposing native C++ bindings to JavaScript- Node

---

Expand All @@ -14,18 +14,22 @@ AppJS is an SDK to develop desktop applications using Node.js melded with Chromi
* __Mailing List: [mailing list](https://groups.google.com/forum/#!forum/appjs-dev)__
* __IRC: #appjs at irc.freenode.net__

---

__AppJS is under heavy development. Expect many API changes and things to break.__

## 30 Second Quickstart
The below packages include everything needed to get started with AppJS, including Node.js, all dependencies, binaries, and a launcher ready to go out of the box. 1.) Extract to a folder. 2.) Double click on launch. 3.) Hello World.

__AppJS 0.0.17 Distributables:__
__AppJS 0.0.18 Distributables:__

* Linux [32 bit](http://dists.appjs.org/0.0.18/appjs-0.0.18-linux-ia32.tar.gz) / [64 bit](http://dists.appjs.org/0.0.18/appjs-0.0.18-linux-x64.tar.gz) -> app.sh
* [Mac](http://dists.appjs.org/0.0.18/appjs-0.0.18-darwin-ia32.zip) -> app.sh
* [Windows](http://dists.appjs.org/0.0.18/appjs-0.0.18-win32-ia32.zip) -> app.exe

__npm install__
AppJS can be now be installed via npm.

npm install appjs

__AppJS requires 32bit Node on OS X__. It works on 64bit OS X but __Node must be 32bit__. We're working on solving this, but it's a limitation of Chrome itself so it's a work in progress.

* Linux [32 bit](http://dists.appjs.org/0.0.17/appjs-0.0.17-linux-ia32.tar.gz) / [64 bit](http://dists.appjs.org/0.0.17/appjs-0.0.17-linux-x64.tar.gz) -> app.sh
* [Mac](http://dists.appjs.org/0.0.17/appjs-0.0.17-darwin-ia32.zip) -> app.sh
* [Windows](http://dists.appjs.org/0.0.17/appjs-0.0.17-win32-ia32.zip) -> app.exe

(Windows requires [MSVC++ 2010 runtimes](http://www.microsoft.com/en-us/download/details.aspx?id=5555))

Expand Down Expand Up @@ -72,29 +76,9 @@ window.on('close', function(){



## Node Install
__Due to the complex dependencies of AppJS, installation via npm is difficult and error prone.__

* First you need [Node 0.8+](https://github.com/joyent/node/wiki/Installation) installed.
* Then use npm to install [node-gyp](https://github.com/TooTallNate/node-gyp): `npm install node-gyp`.
* Finally, install appjs: `npm install appjs`.

Currently the binaries require Node for the following architectures:

* Linux - 64 bit
* Mac - 32 bit
* Windows - 32 bit

## Platform build requirements:

* __Mac OS X__: Currently 32bit node only, `$ node -e "console.log(process.arch)"` -> __ia32__
* __Linux__: `sudo apt-get install libgtk2.0-dev`
* __Windows__: Windows SDK, DirectX SDK, and Visual C++ 2010


## License
( The MIT License )
The MIT License

Copyright (c) 2012 Morteza Milani and other AppJS contributors
Copyright (c) 2012 The AppJS Authors

See the LICENSE file for details.

0 comments on commit e544bba

Please sign in to comment.