Better documentation
This commit is contained in:
25
README.md
25
README.md
@ -1,6 +1,16 @@
|
||||
# reStream
|
||||
|
||||
Snappy reMarkable screen sharing over SSH.
|
||||
reMarkable screen sharing over SSH.
|
||||
|
||||
## 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. If you don't have `zstd` installed, it will ask you to copy it. You can answer no, and it will fall back to gzip (which will be slower).
|
||||
5. 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
|
||||
|
||||
@ -9,6 +19,17 @@ On your **host** machine:
|
||||
- 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.
|
||||
On your **reMarkable** nothing is needed, unless you want...
|
||||
|
||||
### Sub-second latency
|
||||
|
||||
To achieve sub-second latency, you'll need [zstd](https://zstd.net) on your
|
||||
host and on your reMarkable.
|
||||
|
||||
You can install `zstd` on your host with your usual package manager. On Ubuntu,
|
||||
`apt install zstd` will work.
|
||||
|
||||
On your **reMarkable** you can do `opkg install zstd` if you have [entware](https://github.com/evidlo/remarkable_entware) installed. If you don't you can use the binary provided in this repository. In general you shouldn't trust binaries strangers on the internet provide to you, but I provide the option if you don't want the hassle of installing entware.
|
||||
|
||||
You can copy the binary to your remarkable with `scp zstd root@10.11.99.1:/home/root/zstd`.
|
||||
|
||||
|
Reference in New Issue
Block a user