diff --git a/README.md b/README.md index b9fba20..3b21c62 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ ![screenshot](https://raw.githubusercontent.com/bordaigorl/rmview/master/screenshot.png) +## Choose your flavour + +There are two versions of rMview, presenting the same interface but using different back-ends (thus requiring different setups on the reMarkable): + +* The "reStreamer-like" version, in the `master` branch +* The "VNC-based" version, in the `vnc` branch + +In my tests, the VNC version is a clear winner, but it has different requirements, so I am keeping both alive for the moment. + +**Volunteers wanted**: if you have experience with build systems/packaging for python, and/or experience in producing bundles with pyQt, and feel like contributing to the project, drop me a line! + ## Instructions To run the program you need python with pyqt5 installed. @@ -37,25 +48,31 @@ The supported configuration settings are: } ``` -Tested with Python 3, PyQt 5.14.2, MacOs 10.15.4, reMarkable firmware 2.1.1.3 +Tested with Python 3.8.2, PyQt 5.14.2, MacOs 10.15.4, reMarkable firmware 2.1.1.3 ## Requirements -On your computer: +### On your computer: - Python 3 - PyQt5 - Paramiko -- lz4framed +- lz4framed for `master` branch +- Twisted for `vnc` branch They can be installed via `pip install pyqt5 paramiko py-lz4framed`. If you use Anaconda, please install the dependencies via `conda` (and not `pip`). -On the reMarkable: +### On the reMarkable: -- lz4 which can be installed by running `scp lz4.arm.static :lz4`. +*"reStreamer-like" version:* + +- LZ4, installed by running `scp lz4.arm.static :lz4`. Make sure `lz4` is executable by running `ssh chmod +x lz4`. +*"VNC-based" version:* + +- Install [rM-vnc-server][vnc] and its dependency [mxc_epdc_fb_damage](https://github.com/peter-sa/mxc_epdc_fb_damage). Instructions can be found in the [wiki](https://github.com/bordaigorl/rmview/wiki/How-to-run-the-VNC-based-version). ## To Do @@ -65,6 +82,7 @@ On the reMarkable: - [ ] Build system - [ ] Bundle - [ ] Add interaction for Lamy button? (1 331 1 down, 1 331 0 up) + - [ ] Remove dependency to Twisted in `vnc` branch ## Credits @@ -74,6 +92,8 @@ I took inspiration from the following projects: - [QtImageViewer](https://github.com/marcel-goldschen-ohm/PyQtImageViewer/) - [remarkable_mouse](https://github.com/Evidlo/remarkable_mouse/) - [reStream](https://github.com/rien/reStream) +- [rM-vnc-server](https://github.com/peter-sa/rM-vnc-server) +- [VNC client](https://github.com/sibson/vncdotool) originally written by Chris Liechti Icons adapted from designs by Freepik, xnimrodx from www.flaticon.com @@ -86,3 +106,5 @@ This project is not affiliated to, nor endorsed by, [reMarkable AS](https://rema ## Licence GPLv3 + +[vnc]: https://github.com/peter-sa/rM-vnc-server \ No newline at end of file