aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkshay Nair <phenax5@gmail.com>2020-06-19 20:08:19 +0530
committerAkshay Nair <phenax5@gmail.com>2020-06-19 20:08:19 +0530
commit5a80b79e1d0c41a4c566b2f8ff7ab409a3322ea1 (patch)
treeb72040307376970210c63fea484dee84e15a8985
parent5880b74cc8d6f4520a35cc1947d15206bb9ebaa5 (diff)
parent353dab50ea72a4c9b013d0305939f241260c4839 (diff)
downloadshotkey-5a80b79e1d0c41a4c566b2f8ff7ab409a3322ea1.tar.gz
shotkey-5a80b79e1d0c41a4c566b2f8ff7ab409a3322ea1.zip
Merge branch 'master' into personal
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index d5b87d8..cd2a22d 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 used for executing the commands
+* `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.
-