diff --git a/README.md b/README.md index 8d5bf2f..38e3f8c 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures 1. **_Important_**: After inputing your `sudo` password, log out then log back in -## List of Commands - -1. **Start the Program** +1. Start the Program ``` comfortable-swipe start @@ -63,24 +61,19 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures Comfortable swipe is RUNNING in the background ``` -1. **Stop the Program** +1. (Optional) Stop the Program ``` comfortable-swipe stop ``` -1. **Toggle Autostart** (optional) +1. (Optional) Toggle autostart ```bash comfortable-swipe autostart - comfortable-swipe autostart on - comfortable-swipe autostart off - comfortable-swipe autostart toggle - comfortable-swipe autostart status - comfortable-swipe autostart path ``` -1. **Program status** +1. (Optional) See program status ```bash comfortable-swipe status @@ -108,7 +101,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures mouse4 is NOTSET ``` -1. **Get config** +1. (Optional) Get config ``` comfortable-swipe @@ -128,7 +121,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures comfortable-swipe mouse4 ``` -1. **Set config** +1. (Optional) Set config ```bash comfortable-swipe [=] @@ -162,6 +155,16 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures comfortable-swipe --help ``` +1. Autostart commands + + ```bash + comfortable-swipe autostart on + comfortable-swipe autostart off + comfortable-swipe autostart toggle + comfortable-swipe autostart status + comfortable-swipe autostart path + ``` + 1. Show output with `--attach` 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 For the following reasons: -1. We want prioritize "comfort" over functionality, which we deliver through performance in our near-zero-overhead implementation (that's why C++) -2. Running a new shell command with unpredictable process time will break our unthreaded optimizations (unlike native keystrokes) -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 +1. We want prioritize "comfort" over functionality, which we deliver through performance in our negligible-overhead implementation (that's why C++) +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 +1. Running a new shell command with unpredictable process time will break our unthreaded optimizations (unlike native keystrokes) -That's why it's not possible... +That's why it's not possible... or not? -**Answer 2**: _... but actually **YES**!_ +**Answer 2**: _... but actually **IT'S POSSIBLE**!_ Although we don't provide this out of the box in our config, this can definitely be done with the default bash tools.