From 726d0842f883b8090cdac259e097a7999cbed67e Mon Sep 17 00:00:00 2001 From: Rien Maertens Date: Thu, 12 Mar 2020 08:43:17 +0100 Subject: [PATCH] Update README - add installation instructions - remove mention of script copying zstd --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a169415..da7f8cd 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,17 @@ 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. (Optionally) [Install zstd 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. 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! +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).