Skip to content

Commit 7b300d5

Browse files
committed
update README
1 parent 769521c commit 7b300d5

File tree

1 file changed

+12
-38
lines changed

1 file changed

+12
-38
lines changed

README.md

Lines changed: 12 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ ttyd is a simple command-line tool for sharing terminal over the web.
88

99
# Features
1010

11-
- Built on top of [Libwebsockets](https://libwebsockets.org) with [libuv](https://libuv.org) for speed
12-
- Fully-featured terminal based on [Xterm.js](https://xtermjs.org) with [CJK](https://en.wikipedia.org/wiki/CJK_characters) and IME support
13-
- Graphical [ZMODEM](https://en.wikipedia.org/wiki/ZMODEM) integration with [lrzsz](https://ohse.de/uwe/software/lrzsz.html) support
14-
- [Sixel](https://en.wikipedia.org/wiki/Sixel) image output support ([Usage](https://saitoha.github.io/libsixel/))
11+
- Built on top of [libuv](https://libuv.org) and [WebGL2](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) for speed
12+
- Fully-featured terminal with [CJK](https://en.wikipedia.org/wiki/CJK_characters) and IME support
13+
- [ZMODEM](https://en.wikipedia.org/wiki/ZMODEM) ([lrzsz](https://ohse.de/uwe/software/lrzsz.html)) / [trzsz](https://trzsz.github.io) file transfer support
14+
- [Sixel](https://en.wikipedia.org/wiki/Sixel) image output support ([img2sixel](https://saitoha.github.io/libsixel) / [lsix](https://github.com/hackerb9/lsix))
1515
- SSL support based on [OpenSSL](https://www.openssl.org) / [Mbed TLS](https://github.com/Mbed-TLS/mbedtls)
1616
- Run any custom command with options
1717
- Basic authentication support and many other custom options
@@ -23,56 +23,30 @@ ttyd is a simple command-line tool for sharing terminal over the web.
2323

2424
## Install on macOS
2525

26-
Install with [homebrew](http://brew.sh):
27-
28-
```bash
29-
brew install ttyd
30-
```
31-
32-
Install with [MacPorts](https://www.macports.org):
33-
34-
```bash
35-
sudo port install ttyd
36-
```
26+
- Install with [homebrew](http://brew.sh): `brew install ttyd`
27+
- Install with [MacPorts](https://www.macports.org): `sudo port install ttyd`
3728

3829
## Install on Linux
3930

40-
- Binary version (recommended): download from the [releases](https://github.com/tsl0922/ttyd/releases) page.
41-
42-
- Install the snap:
43-
44-
`sudo snap install ttyd --classic`
45-
46-
31+
- Binary version (recommended): download from the [releases](https://github.com/tsl0922/ttyd/releases) page
32+
- Install the snap: `sudo snap install ttyd --classic`
4733
- Build from source (debian/ubuntu):
48-
4934
```bash
5035
sudo apt-get install build-essential cmake git libjson-c-dev libwebsockets-dev
5136
git clone https://github.com/tsl0922/ttyd.git
5237
cd ttyd && mkdir build && cd build
5338
cmake ..
5439
make && sudo make install
5540
```
56-
5741
You may also need to compile/install [libwebsockets](https://libwebsockets.org) from source if the `libwebsockets-dev` package is outdated.
58-
42+
- Install on OpenWrt: `opkg install ttyd`
5943
- Install on Gentoo: clone the [repo](https://bitbucket.org/mgpagano/ttyd/src/master) and follow the directions [here](https://wiki.gentoo.org/wiki/Custom_repository#Creating_a_local_repository).
6044

6145
## Install on Windows
6246

63-
[Compile on Windows](https://github.com/tsl0922/ttyd/wiki/Compile-on-Windows).
64-
65-
Install with [Scoop](https://scoop.sh/#/apps?q=ttyd&s=2&d=1&o=true):
66-
```
67-
scoop install ttyd
68-
```
69-
70-
71-
## Install on OpenWrt
72-
73-
```bash
74-
opkg install ttyd
75-
```
47+
- Binary version (recommended): download from the [releases](https://github.com/tsl0922/ttyd/releases) page
48+
- Install with [Scoop](https://scoop.sh/#/apps?q=ttyd&s=2&d=1&o=true): `scoop install ttyd`
49+
- [Compile on Windows](https://github.com/tsl0922/ttyd/wiki/Compile-on-Windows)
7650

7751
# Usage
7852

0 commit comments

Comments
 (0)