add quickstart section, show options
This commit is contained in:
25
README.md
25
README.md
@@ -6,7 +6,9 @@ Special thanks to [canselcik](https://github.com/canselcik/libremarkable) and [L
|
||||
|
||||
<img src="photo.jpg" width=500>
|
||||
|
||||
# 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)
|
||||
|
||||
Reference in New Issue
Block a user