From 9dea2713d5691fa925d5f053ed6e52f7c6fc6a72 Mon Sep 17 00:00:00 2001 From: Akshay Date: Sat, 30 Nov 2019 17:04:58 +0530 Subject: doc --- readme.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index f7083ca..a846024 100644 --- a/readme.md +++ b/readme.md @@ -10,9 +10,14 @@ to build `xcursorlocate`, you require the `libxcb-devel` package (please follow [these](https://www.rust-lang.org/tools/install) instructions to install `cargo` and `rust`). ```shell +# from crates.io +$ cargo install xcursorlocate + +# from github $ git clone https://github.com/nerdypepper/xcursorlocate $ cd xcursorlocate $ cargo install --force --path ./ + # make sure to add ~/.cargo/bin to your $PATH ``` @@ -31,13 +36,18 @@ ctrl + Escape: `xcursorlocate` is configured via a `.toml` file, which is present in `$XDG_CONFIG_HOME/xcursorlocate`. a basic config is generated on first run, a sample config can be found in -the [`examples`](./examples/sample_config.toml) directory. +the [`examples`](./examples/sample_config.toml) directory +(may not always be up to date). ### uninstall :( ``` +# using cargo +$ cargo uninstall xcursorlocate + +# manually $ rm -rf xcursorlocate/ $ rm -rf ~/.config/xcursorlocate/ $ rm -f $HOME/.cargo/bin/xcursorlocate -- cgit v1.2.3