Skip to content

Commit 859d3f3

Browse files
committed
Update README
1 parent f56e0a6 commit 859d3f3

File tree

1 file changed

+62
-57
lines changed

1 file changed

+62
-57
lines changed

README.md

Lines changed: 62 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -63,103 +63,106 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
6363
Comfortable swipe is RUNNING in the background
6464
```
6565

66-
1. Autostart (this is turned on by default)
66+
1. List configurations
6767

6868
```bash
69-
comfortable-swipe autostart [on|off|toggle|status|path]
69+
comfortable-swipe config list
7070
```
7171

72-
1. List configurations
72+
Example:
7373

7474
```bash
75-
If you want to list down configurations, you can run:
76-
77-
comfortable-swipe config list
78-
79-
Configuration:
75+
$ comfortable-swipe config list
76+
threshold = 1.0
77+
left4 = ctrl+super+shift+Right
78+
right3 = ctrl+super+Left
79+
right4 = ctrl+super+shift+Left
80+
up3 = ctrl+F12
81+
up4 = super+d
82+
down3 = ctrl+F12
83+
down4 = super+d
84+
mouse4 = button1
85+
left3 = ctrl+super+Right
86+
```
8087

81-
comfortable-swipe <PROPERTY> gets configuration property
82-
comfortable-swipe <PROPERTY> [=] <VALUE> sets configuration to a value
88+
1) Get config
8389

84-
Valid props: left3, left4, right3, right4, up3, up4, down3, down4, threshold, mouse3, mouse4
90+
```
91+
comfortable-swipe <PROPERTY>
8592
```
8693

87-
1. Get config (examples)
94+
Examples:
8895

8996
```bash
9097
$ comfortable-swipe left3
9198
ctrl+alt+Right
99+
```
92100

101+
```bash
93102
$ comfortable-swipe left4
94103
ctrl+alt+shift+Right
104+
```
95105

96-
$ comfortable-swipe right3
97-
ctrl+alt+Left
98-
99-
$ comfortable-swipe right4
100-
ctrl+alt+shift+Left
101-
102-
$ comfortable-swipe up3
103-
ctrl+alt+Down
104-
105-
$ comfortable-swipe up4
106-
ctrl+alt+shift+Down
107-
108-
$ comfortable-swipe down3
109-
ctrl+alt+Up
110-
111-
$ comfortable-swipe down4
112-
ctrl+alt+shift+Up
113-
106+
```bash
114107
$ comfortable-swipe threshold
115108
1.0
116109
```
117110

118-
1. Set config (examples)
111+
1) Set config
119112

120113
```bash
121-
$ comfortable-swipe left3 = super+Right
122-
left3 = super+Right
114+
comfortable-swipe <PROPERTY> [=] <VALUES>
115+
```
123116

124-
$ comfortable-swipe right3 = super+Left
125-
right3 = super+Left
117+
Examples:
126118

127-
$ comfortable-swipe right4 = super + Left + alt
128-
right4 = super+Left+alt
119+
```bash
120+
comfortable-swipe left3 super+Right
121+
comfortable-swipe right3 super+Left
122+
comfortable-swipe right4 ctrl alt + Left
123+
comfortable-swipe down4 super+d
124+
comfortable-swipe up3 = ctrl+shift+Up
129125
```
130126

131-
1. Delete config
127+
1) Show path to config file:
132128

133129
```bash
134-
$ comfortable-swipe config delete mouse3
135-
Deleted:
136-
mouse3 = button1
130+
$ comfortable-swipe config path
131+
/home/hikari9/.config/comfortable-swipe.conf
137132
```
138133

139-
1. List all cofigurations
134+
<details>
135+
<summary>Other Commands</summary>
136+
137+
1. Autostart
140138

141139
```bash
142-
$ comfortable-swipe config list
143-
threshold = 1.0
144-
left4 = ctrl+super+shift+Right
145-
right3 = ctrl+super+Left
146-
right4 = ctrl+super+shift+Left
147-
up3 = ctrl+F12
148-
up4 = super+d
149-
down3 = ctrl+F12
150-
down4 = super+d
151-
mouse4 = button1
152-
left3 = ctrl+super+Right
140+
comfortable-swipe autostart
141+
comfortable-swipe autostart on
142+
comfortable-swipe autostart off
143+
comfortable-swipe autostart toggle
144+
comfortable-swipe autostart status
145+
comfortable-swipe autostart path
153146
```
154147

155-
1. Show path to config file:
148+
1. Configurations
156149

157150
```bash
158-
$ comfortable-swipe config path
159-
/home/hikari9/.config/comfortable-swipe.conf
151+
comfortable-swipe config list
152+
comfortable-swipe config get <PROPERTY>
153+
comfortable-swipe config set <PROPERTY> [=] <VALUE>
154+
comfortable-swipe config path
155+
comfortable-swipe config keys
156+
```
157+
158+
1. Help and Version
159+
160+
```bash
161+
comfortable-swipe --version
162+
comfortable-swipe --help
160163
```
161164

162-
1. (Advanced) Show output with `--attach`
165+
1. Show output with `--attach`
163166

164167
Example output of 3-finger left, 4-finger left, 3-finger right, 3-finger up:
165168

@@ -174,6 +177,8 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
174177

175178
You can also pass `--bare` to attach without actually swiping.
176179

180+
</details>
181+
177182
## Swipe Gesture Configurations
178183

179184
The default configuration file is located at `~/.config/comfortable-swipe.conf`.

0 commit comments

Comments
 (0)