Mark/restream
1
0
Fork 0
Code Actions Releases Activity

Update README

Browse Source 
- add installation instructions
- remove mention of script copying zstd
This commit is contained in:
Rien Maertens 2020-03-12 08:43:17 +01:00
parent d0c5ffe9e1
commit 726d0842f8
No known key found for this signature in database
GPG Key ID: AE66CE42F1AF9DEF
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -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).