Skip to content

Commit c5d81a0

Browse files
committed
Add contributing file
Fixes #836
1 parent fb4ae52 commit c5d81a0

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Testing in a real terminal
2+
3+
The recommended way to test node-pty during development is to clone the xterm.js repository and link's node-pty module to this directory.
4+
5+
1. Clone xterm.js in a separate folder:
6+
```sh
7+
git clone https://github.com/xtermjs/xterm.js
8+
npm ci
9+
npm run setup
10+
```
11+
2. Link the node-pty repo:
12+
```
13+
rm -rf node_modules/node-pty # in xterm.js folder
14+
ln -s <path_to_node-pty> <path to xtermjs>/node_modules/node-pty
15+
```
16+
3. Hit ctrl/cmd+shift+b in VS Code or run the build/demo scripts manually:
17+
```sh
18+
npm run tsc-watch # build ts
19+
npm run esbuild-watch # bundle ts/js
20+
npm run esbuild-demo # build demo/server
21+
npm run start # run server
22+
```
23+
4. Open http://127.0.0.1:3000 and test
24+
5. Kill and restart the `npm run start` command to apply any changes made in node-pty

0 commit comments

Comments
 (0)