restream/README.md

# reStream

Snappy reMarkable screen sharing over SSH.

## Requirements

On your **host** machine:
- Any POSIX-shell (e.g. bash)
- ffmpeg (with ffplay)
- ssh

On your **reMarkable** it is recommended to install [zstd](https://zstd.net) (`opkg install zstd` if you have [entware](https://github.com/evidlo/remarkable_entware) installed.) to have a smoother experience (sub-second latency). However, if you don't have it installed `reStream` will fall back to `gzip` which is installed by default.
Add README 2020-02-12 13:19:06 +01:00			`# reStream`

			`Snappy reMarkable screen sharing over SSH.`

			`## Requirements`

			`On your host machine:`
			`- Any POSIX-shell (e.g. bash)`
Add installation instructions 2020-02-12 13:51:59 +01:00			`- ffmpeg (with ffplay)`
Add README 2020-02-12 13:19:06 +01:00			`- ssh`

Graceful fallback to gzip if zstd is not present 2020-02-12 14:47:47 +01:00			On your reMarkable it is recommended to install [zstd](https://zstd.net) (`opkg install zstd` if you have [entware](https://github.com/evidlo/remarkable_entware) installed.) to have a smoother experience (sub-second latency). However, if you don't have it installed `reStream` will fall back to `gzip` which is installed by default.