From 5d83cdb1c48ca248a59975fea0e1d1692fe8fb46 Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Fri, 19 Jun 2020 20:07:31 +0530 Subject: Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) 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. - -- cgit v1.3.1 From 353dab50ea72a4c9b013d0305939f241260c4839 Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Fri, 19 Jun 2020 20:07:47 +0530 Subject: Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b96d9ff..cd2a22d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ sudo make install ## Configuring You can edit `config.h` to configure key bindings. -* `shell` - Configure the shell +* `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 -- cgit v1.3.1