diff options
author | Akshay <[email protected]> | 2019-11-30 11:34:58 +0000 |
---|---|---|
committer | Akshay <[email protected]> | 2019-11-30 11:34:58 +0000 |
commit | 9dea2713d5691fa925d5f053ed6e52f7c6fc6a72 (patch) | |
tree | 34675f8e431b47e4c7ec1cb2082ca460c3949d27 | |
parent | 20bc88ae56e1b7fa4004f0a0acbb28f2f0c7e4a2 (diff) |
doc
-rw-r--r-- | readme.md | 12 |
1 files changed, 11 insertions, 1 deletions
@@ -10,9 +10,14 @@ to build `xcursorlocate`, you require the `libxcb-devel` | |||
10 | package (please follow [these](https://www.rust-lang.org/tools/install) instructions to install `cargo` and `rust`). | 10 | package (please follow [these](https://www.rust-lang.org/tools/install) instructions to install `cargo` and `rust`). |
11 | 11 | ||
12 | ```shell | 12 | ```shell |
13 | # from crates.io | ||
14 | $ cargo install xcursorlocate | ||
15 | |||
16 | # from github | ||
13 | $ git clone https://github.com/nerdypepper/xcursorlocate | 17 | $ git clone https://github.com/nerdypepper/xcursorlocate |
14 | $ cd xcursorlocate | 18 | $ cd xcursorlocate |
15 | $ cargo install --force --path ./ | 19 | $ cargo install --force --path ./ |
20 | |||
16 | # make sure to add ~/.cargo/bin to your $PATH | 21 | # make sure to add ~/.cargo/bin to your $PATH |
17 | ``` | 22 | ``` |
18 | 23 | ||
@@ -31,13 +36,18 @@ ctrl + Escape: | |||
31 | `xcursorlocate` is configured via a `.toml` file, which is | 36 | `xcursorlocate` is configured via a `.toml` file, which is |
32 | present in `$XDG_CONFIG_HOME/xcursorlocate`. a basic config | 37 | present in `$XDG_CONFIG_HOME/xcursorlocate`. a basic config |
33 | is generated on first run, a sample config can be found in | 38 | is generated on first run, a sample config can be found in |
34 | the [`examples`](./examples/sample_config.toml) directory. | 39 | the [`examples`](./examples/sample_config.toml) directory |
40 | (may not always be up to date). | ||
35 | 41 | ||
36 | ### uninstall | 42 | ### uninstall |
37 | 43 | ||
38 | :( | 44 | :( |
39 | 45 | ||
40 | ``` | 46 | ``` |
47 | # using cargo | ||
48 | $ cargo uninstall xcursorlocate | ||
49 | |||
50 | # manually | ||
41 | $ rm -rf xcursorlocate/ | 51 | $ rm -rf xcursorlocate/ |
42 | $ rm -rf ~/.config/xcursorlocate/ | 52 | $ rm -rf ~/.config/xcursorlocate/ |
43 | $ rm -f $HOME/.cargo/bin/xcursorlocate | 53 | $ rm -f $HOME/.cargo/bin/xcursorlocate |