Skip to content

Commit cf28377

Browse files
committed
Update README with install instructions
1 parent 24a61c4 commit cf28377

File tree

1 file changed

+49
-6
lines changed

1 file changed

+49
-6
lines changed

README.md

Lines changed: 49 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,62 @@
11
Gebaar
22
=========
33

4-
WM Independent Gesture Daemon for libinput
4+
WM Independent Touchpad Gesture Daemon for libinput
55

66
_Gebaar means Gesture in Dutch_
77

8+
Run any command by simply gesturing on your touchpad!
9+
10+
### How to install
11+
12+
- Move gebaard to `/usr/bin` or `~/bin`
13+
- Run `mkdir -p ~/.config/gebaar`
14+
- Run `nano ~/.config/gebaar/gebaard.toml` (or vim, if you like it better)
15+
- Add the following snippet to `gebaard.toml`
16+
17+
```toml
18+
[commands.swipe.three]
19+
up = ""
20+
down = ""
21+
left = ""
22+
right = ""
23+
24+
[commands.swipe.four]
25+
up = ""
26+
down = ""
27+
left = ""
28+
right = ""
29+
```
30+
- Configure commands to run per direction
31+
- Run it in some startup file via `gebaard -b`
32+
33+
### Examples
34+
35+
**bspwm**
36+
37+
_~/.config/gebaar/gebaard.toml_
38+
```toml
39+
[commands.swipe.three]
40+
up = "bspc node -f north"
41+
down = "bspc node -f south"
42+
left = "bspc node -f west"
43+
right = "bspc node -f east"
44+
45+
[commands.swipe.four]
46+
up = "rofi -show combi"
47+
down = ""
48+
left = "bspc desktop -f prev"
49+
right = "bspc desktop -f next"
50+
```
51+
52+
Add `gebaard -b` to `~/.config/bspwm/bspwmrc`
53+
854
### State of the project
955

1056
- [x] Receiving swipe events from libinput
1157
- [ ] Receiving pinch/zoom events from libinput
1258
- [ ] Receiving rotation events from libinput
1359
- [x] Converting libinput events to motions
14-
- [ ] Running commands based on motions
15-
- [ ] Refactor code to be up to Release standards, instead of testing-hell
16-
17-
### Screenshots of debug/testing output
60+
- [x] Running commands based on motions
61+
- [x] Refactor code to be up to Release standards, instead of testing-hell
1862

19-
![gestures](doc/swipes.png)

0 commit comments

Comments
 (0)