Merge remote-tracking branch 'upstream/master' into linkify_issues

This commit is contained in:
Daniel Imms
2017-02-27 12:59:59 -08:00
2 changed files with 21 additions and 6 deletions
+20 -5
View File
@@ -48,14 +48,29 @@ Xterm.js works seamlessly in Electron apps and may even work on earlier versions
## Demo
To launch the demo simply run:
### Linux or macOS
Run the following commands:
```
npm install
npm start
$ npm install
$ npm start
```
Then open http://0.0.0.0:3000 in a web browser (use http://127.0.0.1:3000 if running under Windows).
Then open http://0.0.0.0:3000 in a web browser.
### Windows
First, ensure [node-gyp](https://github.com/nodejs/node-gyp) is installed and configured correctly, then run these commands.
Note: Do not use ConEmu, as it seems to break the demo for some reason.
```
> npm install
> npm start
```
Then open http://127.0.0.1:3000 in a web browser.
## Getting Started
@@ -77,7 +92,7 @@ To start using xterm.js on your browser, add the `xterm.js` and `xterm.css` to t
</body>
</html>
```
Finally instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`.
Finally instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`.
## Addons
+1 -1
View File
@@ -60,7 +60,7 @@
"sleep": "^3.0.1",
"sorcery": "^0.10.0",
"tslint": "^4.0.2",
"typescript": "^2.0.3",
"typescript": "~2.1.0",
"vinyl-buffer": "^1.0.0",
"vinyl-source-stream": "^1.1.0"
},