diff --git a/README.md b/README.md new file mode 100644 index 0000000..cee069d --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# reStream + +Snappy reMarkable screen sharing over SSH. + +## Requirements + +On your **host** machine: +- Any POSIX-shell (e.g. bash) +- [zstd](http://www.zstd.net/) +- ssh +- ffmpeg (with ffmplay) + +On your **reMarkable**: +- Any POSIX-shell +- [zstd](http://www.zstd.net/) +- netcat +- coreutils-head