ervin/comfortable-swipe
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Rico Tiongson 2020-05-07 23:39:00 +08:00
parent b2d1674ba4
commit 404e8febcc
1 changed files with 50 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
README.md
View File

@ -50,7 +50,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
## List of Commands
1. Start the Program
1. **Start the Program**
```
comfortable-swipe start
@ -63,56 +63,27 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
Comfortable swipe is RUNNING in the background
```
1. List configurations
```bash
comfortable-swipe config list
```
<details> <summary> Example: </summary>
```bash
$ comfortable-swipe config list
threshold = 1.0
left4 = ctrl+super+shift+Right
right3 = ctrl+super+Left
right4 = ctrl+super+shift+Left
up3 = ctrl+F12
up4 = super+d
down3 = ctrl+F12
down4 = super+d
mouse4 = button1
left3 = ctrl+super+Right
```
</details>
1) Get config
1. **Get config**
```
comfortable-swipe <PROPERTY>
```
<details> <summary> Examples: </summary>
```bash
$ comfortable-swipe left3
ctrl+alt+Right
comfortable-swipe left3
comfortable-swipe left4
comfortable-swipe right3
comfortable-swipe right4
comfortable-swipe up3
comfortable-swipe up4
comfortable-swipe down3
comfortable-swipe down4
comfortable-swipe threshold
comfortable-swipe mouse3
comfortable-swipe mouse4
```
```bash
$ comfortable-swipe left4
ctrl+alt+shift+Right
```
```bash
$ comfortable-swipe threshold
1.0
```
</details>
1) Set config
1) **Set config**
```bash
comfortable-swipe <PROPERTY> [=] <VALUES>
@ -126,14 +97,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
comfortable-swipe up3 = ctrl+shift+Up
```
1) Show path to config file:
```bash
$ comfortable-swipe config path
/home/hikari9/.config/comfortable-swipe.conf
```
1) Autostart
1) **Toggle Autostart**
```bash
comfortable-swipe autostart
@ -147,7 +111,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
<details>
<summary><b>Other Commands</b></summary>
1. Configurations
1. All Configuration commands
```bash
comfortable-swipe config list
@ -177,7 +141,39 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
...
```
You can also pass `--bare` to attach without actually swiping.
1. Test output with `--bare` to attach without actually swiping
```bash
$ comfortable-swipe start --bare
SWIPE left3
SWIPE left4
SWIPE right3
SWIPE up3
...
```
1. Debug
```bash
$ comfortable-swipe debug
...
-event9 DEVICE_ADDED TouchPad seat0 default group7 cap:pg size 70x50mm tap(dl off) left scroll-nat scroll-2fg-edge click-buttonareas-clickfinger dwt-on
...
event9 GESTURE_SWIPE_BEGIN +2.03s 3
event9 GESTURE_SWIPE_UPDATE +2.03s 3 -9.95/ 2.64 (-26.90/ 7.12 unaccelerated)
event9 GESTURE_SWIPE_UPDATE +2.03s 3 -10.44/ 3.19 (-28.22/ 8.62 unaccelerated)
event9 GESTURE_SWIPE_UPDATE +2.04s 3 -9.71/ 2.64 (-26.25/ 7.12 unaccelerated)
event9 GESTURE_SWIPE_UPDATE +2.05s 3 -8.98/ 2.64 (-24.28/ 7.12 unaccelerated)
event9 GESTURE_SWIPE_UPDATE +2.06s 3 -7.40/ 2.36 (-20.01/ 6.37 unaccelerated)
event9 GESTURE_SWIPE_UPDATE +2.06s 3 -6.31/ 2.50 (-17.06/ 6.75 unaccelerated)
event9 GESTURE_SWIPE_UPDATE +2.07s 3 -5.34/ 1.80 (-14.44/ 4.87 unaccelerated)
event9 GESTURE_SWIPE_UPDATE +2.08s 3 -4.61/ 2.08 (-12.47/ 5.62 unaccelerated)
event9 GESTURE_SWIPE_UPDATE +2.09s 3 -4.49/ 1.53 (-12.14/ 4.12 unaccelerated)
event9 GESTURE_SWIPE_UPDATE +2.09s 3 -4.01/ 1.25 (-10.83/ 3.37 unaccelerated)
event9 GESTURE_SWIPE_UPDATE +2.10s 3 -4.13/ 0.42 (-11.15/ 1.12 unaccelerated)
event9 GESTURE_SWIPE_END +2.11s 3
...
```
</details>
@ -494,10 +490,7 @@ Running shell commands our **NOT** part of the core features of comfortable-swip
but through the default bash tools you can _mimic_ this functionality via our program output.
<details>
<summary>
**Use Case**: _"I want to run `gnome-terminal` if I swipe up with 3 fingers."_
<summary> <b>Use Case</b>: <i>"I want to run <code>gnome-terminal</code> if I swipe up with 3 fingers."</i>
</summary>
1. Attach the program to the shell: