Mark/restream
1
0
Fork 0
Code Actions Releases Activity

Add parameters to README, ssh timeout to 1s

Browse Source 
Changed the README to reflect the command line options added with
bcf62e3. Also incorporates the SSH timeout of 1 second added by the
initial PR (#10).

Co-authored-by: Aaron David Schneider <aaron.david.schneider@gmail.com>
This commit is contained in:
Rien Maertens
2020-04-02 14:14:36 +02:00
parent bcf62e3ae7
commit 382944058e
2 changed files with 24 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -14,9 +14,14 @@ reMarkable screen sharing over SSH.
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` for landscape mode, or `./reStram.sh -p` for portrait mode.
3. Run `./reStream.sh`
4. A screen will pop-up on your local machine, with a live view of your reMarkable!
### Options
- `-p --portrait`: shows the reMarkable screen in portrait mode (the default is landscape mode, 90 degrees rotated tot the right)
- `-d --destination`: the ssh destination of the reMarkable (default: `root@10.11.99.1`)
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