From e1597619158e3ea0cc8397c0f802d0780d252ae6 Mon Sep 17 00:00:00 2001 From: evan Date: Sun, 19 Apr 2020 22:48:25 -0500 Subject: [PATCH] add quickstart section, show options --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3141345..8e8e4da 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ Special thanks to [canselcik](https://github.com/canselcik/libremarkable) and [L -# Usage +# Quick Start + +On the host machine ``` bash pip install remarkable-mouse @@ -26,3 +28,24 @@ ssh-keygen -f ~/.ssh/remarkable -N '' ssh-copy-id -i ~/.ssh/remarkable.pub root@10.11.99.1 remouse --key ~/.ssh/remarkable ``` + +# Usage + + usage: remouse [-h] [--debug] [--key PATH] [--password PASSWORD] + [--address ADDRESS] [--orientation {vertical,left,right}] + [--monitor NUM] [--threshold THRESHOLD] [--evdev] + + use reMarkable tablet as a mouse input + + optional arguments: + -h, --help show this help message and exit + --debug enable debug messages + --key PATH ssh private key + --password PASSWORD ssh password + --address ADDRESS device address + --orientation {vertical,left,right} + --monitor NUM monitor to use + --threshold THRESHOLD + stylus pressure threshold (default 1000) + --evdev use evdev to support pen tilt (requires root, no OSX + support)