Skip to content

Commit

Permalink
Mention minimum go compiler version
Browse files Browse the repository at this point in the history
Also npm is required.
  • Loading branch information
yudai committed Sep 28, 2017
1 parent 513b3a5 commit 0bb62e0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -28,7 +28,7 @@ $ brew install yudai/gotty/gotty

## `go get` Installation (Development)

If you have a Go language environment, you can install GoTTY with the `go get` command. However, this command builds a binary file from the latest master branch, which can include unstable or breaking changes.
If you have a Go language environment, you can install GoTTY with the `go get` command. However, this command builds a binary file from the latest master branch, which can include unstable or breaking changes. GoTTY requires go1.9 or later.

```sh
$ go get github.com/yudai/gotty
Expand Down Expand Up @@ -162,6 +162,8 @@ go get github.com/tools/godep
make
```

To build the frontend part (JS files and other static files), you need `npm`.

## Architecture

GoTTY uses [xterm.js](https://xtermjs.org/) and [hterm](https://groups.google.com/a/chromium.org/forum/#!forum/chromium-hterm) to run a JavaScript based terminal on web browsers. GoTTY itself provides a websocket server that simply relays output from the TTY to clients and receives input from clients and forwards it to the TTY. This hterm + websocket idea is inspired by [Wetty](https://github.com/krishnasrinivas/wetty).
Expand Down

0 comments on commit 0bb62e0

Please sign in to comment.