aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2021-02-24 22:39:52 +0100
committerMattias Andrée <maandree@kth.se>2021-02-24 22:39:52 +0100
commit0bd4ca691a14d639229c37cb280de0facf2d4312 (patch)
tree363f4aac374bdcffeb061c23a217d7b446cdf406 /README
parentIgnore -- (diff)
downloadxkbdbind-0bd4ca691a14d639229c37cb280de0facf2d4312.tar.gz
xkbdbind-0bd4ca691a14d639229c37cb280de0facf2d4312.tar.bz2
xkbdbind-0bd4ca691a14d639229c37cb280de0facf2d4312.tar.xz
Update readme
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'README')
-rw-r--r--README23
1 files changed, 19 insertions, 4 deletions
diff --git a/README b/README
index 4a09bd5..9ccf793 100644
--- a/README
+++ b/README
@@ -1,5 +1,20 @@
-Depends on
+NAME
+ xkbdbind - global hotkeys for X
- libxcb
- xcb-util-keysyms
- xproto
+SYNOPSIS
+ xkbdbind
+
+DESCRIPTION
+ xkbdbind lets the user configure keybindings to start
+ programs.
+
+ xkbdbind is a configured by the user by editing the
+ config.h source file and recompiling the program. The
+ user shall therefore have a local copy of the software,
+ and a personal installation of it. Thus, xkbdbind is
+ not a program that is top be installed system-wide.
+
+ Download xkbdbind to ~/.local/src/xkbdbind, run make(1)
+ in ~/.local/src/xkbdbind, link ~/.local/bin/xkbdbind to
+ ~/.local/src/xkbdbind/xkbdbind, and ~/.local/bin to the
+ PATH environment variable if you haven't alreay.