Skip to content

Commit 9d25f1c

Browse files
authored
Update README.md
1 parent 9deaf2d commit 9d25f1c

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
4848

4949
1. **_Important_**: After inputing your `sudo` password, log out then log back in
5050

51-
## List of Commands
52-
53-
1. **Start the Program**
51+
1. Start the Program
5452

5553
```
5654
comfortable-swipe start
@@ -63,24 +61,19 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
6361
Comfortable swipe is RUNNING in the background
6462
```
6563

66-
1. **Stop the Program**
64+
1. (Optional) Stop the Program
6765

6866
```
6967
comfortable-swipe stop
7068
```
7169

72-
1. **Toggle Autostart** (optional)
70+
1. (Optional) Toggle autostart
7371

7472
```bash
7573
comfortable-swipe autostart
76-
comfortable-swipe autostart on
77-
comfortable-swipe autostart off
78-
comfortable-swipe autostart toggle
79-
comfortable-swipe autostart status
80-
comfortable-swipe autostart path
8174
```
8275

83-
1. **Program status**
76+
1. (Optional) See program status
8477

8578
```bash
8679
comfortable-swipe status
@@ -108,7 +101,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
108101
mouse4 is NOTSET
109102
```
110103

111-
1. **Get config**
104+
1. (Optional) Get config
112105

113106
```
114107
comfortable-swipe <PROPERTY>
@@ -128,7 +121,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
128121
comfortable-swipe mouse4
129122
```
130123

131-
1. **Set config**
124+
1. (Optional) Set config
132125

133126
```bash
134127
comfortable-swipe <PROPERTY> [=] <VALUES>
@@ -162,6 +155,16 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
162155
comfortable-swipe --help
163156
```
164157

158+
1. Autostart commands
159+
160+
```bash
161+
comfortable-swipe autostart on
162+
comfortable-swipe autostart off
163+
comfortable-swipe autostart toggle
164+
comfortable-swipe autostart status
165+
comfortable-swipe autostart path
166+
```
167+
165168
1. Show output with `--attach`
166169

167170
Example output of 3-finger left, 4-finger left, 3-finger right, 3-finger up:
@@ -504,13 +507,13 @@ If you can see `GESTURE_SWIPE_XXX` in your output, that means your touchpad supp
504507

505508
For the following reasons:
506509

507-
1. We want prioritize "comfort" over functionality, which we deliver through performance in our near-zero-overhead implementation (that's why C++)
508-
2. Running a new shell command with unpredictable process time will break our unthreaded optimizations (unlike native keystrokes)
509-
3. There are other gesture libraries that already do this properly (eg. [libinput gestures](https://github.com/bulletmark/libinput-gestures), [Fusuma](https://github.com/iberianpig/fusuma)), we don't want to be a clone of them
510+
1. We want prioritize "comfort" over functionality, which we deliver through performance in our negligible-overhead implementation (that's why C++)
511+
1. There are other gesture libraries that already do this properly (eg. [libinput gestures](https://github.com/bulletmark/libinput-gestures), [Fusuma](https://github.com/iberianpig/fusuma)), we don't want to be a clone of them
512+
1. Running a new shell command with unpredictable process time will break our unthreaded optimizations (unlike native keystrokes)
510513

511-
That's why it's not possible...
514+
That's why it's not possible... or not?
512515

513-
**Answer 2**: _... but actually **YES**!_
516+
**Answer 2**: _... but actually **IT'S POSSIBLE**!_
514517

515518
Although we don't provide this out of the box in our config, this can definitely be
516519
done with the default bash tools.

0 commit comments

Comments
 (0)