You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-36Lines changed: 30 additions & 36 deletions
Original file line number
Diff line number
Diff line change
@@ -1,43 +1,42 @@
1
1
## Introduction
2
2
3
3
node-webkit is an app runtime based on `Chromium` and `node.js`. You can
4
-
write native apps in HTML and Javascript with node-webkit. It also lets you
4
+
write native apps in HTML and JavaScript with node-webkit. It also lets you
5
5
call Node.js modules directly from the DOM and enables a new way of writing
6
6
native applications with all Web technologies.
7
7
8
8
It's created and developed in the Intel Open Source Technology Center.
9
9
10
10
[Introduction to node-webkit (slides)](https://speakerdeck.com/u/zcbenz/p/node-webkit-app-runtime-based-on-chromium-and-node-dot-js)
11
11
[Creating Desktop Applications With node-webkit](http://strongloop.com/strongblog/creating-desktop-applications-with-node-webkit/)
12
-
[WebApp to DesktopApp with node-webkit (slides)](http://oldgeeksguide.github.io/presentations/html5devconf2013/wtod.html)
12
+
[WebApp to DesktopApp with node-webkit (slides)](http://oldgeeksguide.github.io/presentations/html5devconf2013/wtod.html)
13
+
[Essay on the history and internals of the project](http://yedingding.com/2014/08/01/node-webkit-intro-en.html)
13
14
14
15
## Features
15
16
16
17
* Apps written in modern HTML5, CSS3, JS and WebGL.
17
18
* Complete support for [Node.js APIs](http://nodejs.org/api/) and all its [third party modules](https://npmjs.org).
18
19
* Good performance: Node and WebKit runs in the same thread: Function calls are made straightforward; objects are in the same heap and can just reference each other;
***v0.11.2:** (Nov 26, 2014, based off of Node v0.11.13, Chromium 38.0.2125.104): [release notes](https://groups.google.com/d/msg/node-webkit/hpG-AgsATTI/Oc-qhC3rMnkJ)
***0.8.6:** (Apr 18, 2014, based off of Node v0.10.22, Chrome 30.0.1599.66) **If your native Node module works only with Node v0.10, then you should use node-webkit v0.8.x, which is also a maintained branch. [More info](https://groups.google.com/d/msg/node-webkit/2OJ1cEMPLlA/09BvpTagSA0J)**
**If your native Node module works only with Node v0.10, then you should use node-webkit v0.8.x, which is also a maintained branch. [More info](https://groups.google.com/d/msg/node-webkit/2OJ1cEMPLlA/09BvpTagSA0J)**
You may also be interested in [our demos repository](https://github.com/zcbenz/nw-sample-apps) and the [List of apps and companies using node-webkit](https://github.com/rogerwang/node-webkit/wiki/List-of-apps-and-companies-using-node-webkit).
@@ -68,29 +67,17 @@ Create `package.json`:
68
67
}
69
68
```
70
69
71
-
Compress `index.html` and `package.json` into a zip archive called `app.nw`:
72
-
73
-
````bash
74
-
$ zip app.nw index.html package.json
75
-
````
76
-
77
-
This should create a structure like this:
78
-
79
-
```
80
-
app.nw
81
-
|-- package.json
82
-
`-- index.html
70
+
Run:
71
+
```bash
72
+
$ /path/to/nw . (suppose the current directory contains 'package.json')
83
73
```
84
74
85
-
Download the prebuilt binary for your platform and use it to open the
86
-
`app.nw` file:
87
-
88
-
````bash
89
-
$ ./nw app.nw
90
-
````
91
-
92
-
Note: on Windows, you can drag the `app.nw` to `nw.exe` to open it.
75
+
Note: on Windows, you can drag the folder containing `package.json` to `nw.exe` to open it.
93
76
77
+
Note: on OSX, the executable binary is in a hidden directory within the .app file. To run node-webkit on OSX, type:
78
+
```bash
79
+
$ /path/to/node-webkit.app/Contents/MacOS/node-webkit . (suppose the current directory contains 'package.json')
80
+
```
94
81
## Documents
95
82
96
83
For more information on how to write/package/run apps, see:
@@ -112,3 +99,10 @@ You can chat with us on IRC in the ##node-webkit channel on irc.freenode.net
112
99
## License
113
100
114
101
`node-webkit`'s code in this repo uses the MIT license, see our `LICENSE` file. To redistribute the binary, see [How to package and distribute your apps](https://github.com/rogerwang/node-webkit/wiki/How-to-package-and-distribute-your-apps)
0 commit comments