aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkshay Nair <phenax5@gmail.com>2020-06-19 20:07:31 +0530
committerGitHub <noreply@github.com>2020-06-19 20:07:31 +0530
commit5d83cdb1c48ca248a59975fea0e1d1692fe8fb46 (patch)
treee24eb136a54597cbbfa6e211e34e80f58b6aee0e
parenta0e9f7efd21f22f4fe4c42ee5e8f8ecbad1e61df (diff)
downloadshotkey-5d83cdb1c48ca248a59975fea0e1d1692fe8fb46.tar.gz
shotkey-5d83cdb1c48ca248a59975fea0e1d1692fe8fb46.zip
Update README.md
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index d5b87d8..b96d9ff 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,23 @@ A suckless hot key daemon for X inspired by the suckless philosophy with configu
~200 LOC. ~20KB binary.
+
## Installation
Clone the repo and run
```bash
sudo make install
```
+
## Configuring
You can edit `config.h` to configure key bindings.
+* `shell` - Configure the shell
+* `modes` - A mapping defining all mode keys bindings
+* `keys` - All normal mode key bindings
+* `on_mode_change` - Hook script to listen to mode changes. Useful for status bar integration
+* `mode_properties` - Some meta information about mode. (Label is useful for `on_mode_change`)
+
You can checkout the [personal branch](https://github.com/phenax/hotkeythingy/tree/personal) for my personal config.
Read the man page for more details.
-