diff options
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 39 |
1 files changed, 37 insertions, 2 deletions
@@ -2,9 +2,44 @@ | |||
2 | 2 | ||
3 | > cursor location indicator for x11 | 3 | > cursor location indicator for x11 |
4 | 4 | ||
5 | a la windows xp | 5 | ![preview.gif](screencap.gif) |
6 | 6 | ||
7 | ![preview.png](https://files.nerdypepper.tech/AI.png) | 7 | # install |
8 | |||
9 | to build, `xcursorlocate`, you require the `libxcb-devel` | ||
10 | package. | ||
11 | ```shell | ||
12 | $ git clone https://github.com/nerdypepper/xcursorlocate | ||
13 | $ cd xcursorlocate | ||
14 | $ cargo install --force --path ./ | ||
15 | ``` | ||
16 | |||
17 | # usage | ||
18 | |||
19 | have your window manager trigger `xcursorlocate` on a key | ||
20 | press, i use `sxhkd` to handle key bindings: | ||
21 | ```shell | ||
22 | # ~/.config/sxhkd/sxhkdrc | ||
23 | ctrl + Escape: | ||
24 | xcursorlocate | ||
25 | ``` | ||
26 | |||
27 | # configuration | ||
28 | |||
29 | `xcursorlocate` is configured via a `.toml` file, which is | ||
30 | present in `$XDG_CONFIG_HOME/xcursorlocate`. a basic config | ||
31 | is generated on first run, a sample config can be found in | ||
32 | the [`examples`](./examples/sample_config.toml) directory. | ||
33 | |||
34 | # uninstall | ||
35 | |||
36 | :( | ||
37 | |||
38 | ``` | ||
39 | $ rm -rf xcursorlocate/ | ||
40 | $ rm -rf ~/.config/xcursorlocate/ | ||
41 | $ rm -f $HOME/.cargo/bin/xcursorlocate | ||
42 | ``` | ||
8 | 43 | ||
9 | # todo: | 44 | # todo: |
10 | 45 | ||