restream/README.md

# reStream

reMarkable screen sharing over SSH.

![A demo of reStream](extra/demo.gif)

## Installation

1. Clone this repository: `git clone https://github.com/rien/reStream`
2. (Optional but recommended) [Install lz4 on your host and reMarkable](#sub-second-latency)

## Usage

1. Connect your reMarkable with the USB cable.
2. Make sure you can [open an SSH connection](https://remarkablewiki.com/tech/ssh).
3. Run `./reStream.sh`.
4. A screen will pop-up on your local machine, with a live view of your reMarkable!

If you have problems, don't hesitate to [open an issue](https://github.com/rien/reStream/issues/new) or [send me an email](mailto:rien.maertens@posteo.be).

## Requirements

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

On your **reMarkable** nothing is needed, unless you want...

### Sub-second latency

To achieve sub-second latency, you'll need [lz4](https://github.com/lz4/lz4) 
on your host and on your reMarkable.

You can install `lz4` on your host with your usual package manager. On Ubuntu,
`apt install liblz4-tool` will do the trick.

On your **reMarkable** you'll need a binary of `lz4` build for the arm platform,
you can do this yourself by [installing the reMarkable toolchain](https://remarkablewiki.com/devel/qt_creator#toolchain)
and compiling `lz4` from source with the toolchain enabled, or you can use the
statically linked binary I have already built and put in this repo.

Copy the `lz4` program to your reMarkable with `scp lz4.arm.static root@10.11.99.1:~/lz4` and you're ready to go.
Add README 2020-02-12 13:19:06 +01:00			`# reStream`

Better documentation 2020-03-12 00:17:13 +01:00			`reMarkable screen sharing over SSH.`

Add demo 2020-03-12 00:29:18 +01:00			`![A demo of reStream](extra/demo.gif)`

Update README - add installation instructions - remove mention of script copying zstd 2020-03-12 08:43:17 +01:00			`## Installation`

			1. Clone this repository: `git clone https://github.com/rien/reStream`
Update README with change to lz4 2020-03-18 00:19:28 +01:00			`2. (Optional but recommended) [Install lz4 on your host and reMarkable](#sub-second-latency)`
Update README - add installation instructions - remove mention of script copying zstd 2020-03-12 08:43:17 +01:00
Better documentation 2020-03-12 00:17:13 +01:00			`## Usage`

			`1. Connect your reMarkable with the USB cable.`
			`2. Make sure you can [open an SSH connection](https://remarkablewiki.com/tech/ssh).`
			3. Run `./reStream.sh`.
Update README - add installation instructions - remove mention of script copying zstd 2020-03-12 08:43:17 +01:00			`4. A screen will pop-up on your local machine, with a live view of your reMarkable!`
Better documentation 2020-03-12 00:17:13 +01:00
			`If you have problems, don't hesitate to [open an issue](https://github.com/rien/reStream/issues/new) or [send me an email](mailto:rien.maertens@posteo.be).`
Add README 2020-02-12 13:19:06 +01:00
			`## 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`

Better documentation 2020-03-12 00:17:13 +01:00			`On your reMarkable nothing is needed, unless you want...`

			`### Sub-second latency`

Use lz4 instead of zstd, add prebuilt static library 2020-03-17 23:44:55 +01:00			`To achieve sub-second latency, you'll need [lz4](https://github.com/lz4/lz4)`
			`on your host and on your reMarkable.`
Better documentation 2020-03-12 00:17:13 +01:00
Use lz4 instead of zstd, add prebuilt static library 2020-03-17 23:44:55 +01:00			You can install `lz4` on your host with your usual package manager. On Ubuntu,
			`apt install liblz4-tool` will do the trick.
Better documentation 2020-03-12 00:17:13 +01:00
Use lz4 instead of zstd, add prebuilt static library 2020-03-17 23:44:55 +01:00			On your reMarkable you'll need a binary of `lz4` build for the arm platform,
			`you can do this yourself by [installing the reMarkable toolchain](https://remarkablewiki.com/devel/qt_creator#toolchain)`
			and compiling `lz4` from source with the toolchain enabled, or you can use the
			`statically linked binary I have already built and put in this repo.`
Graceful fallback to gzip if zstd is not present 2020-02-12 14:47:47 +01:00
Use lz4 instead of zstd, add prebuilt static library 2020-03-17 23:44:55 +01:00			Copy the `lz4` program to your reMarkable with `scp lz4.arm.static root@10.11.99.1:~/lz4` and you're ready to go.