alema/hkd
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

modified readme

Browse Source 
fixed typos and updated some info
This commit is contained in:
Alessandro Mauri 2020-07-28 20:32:19 +02:00
parent 472daace31
commit 36ea0ccc6d
1 changed files with 14 additions and 6 deletions

20
README.md
View File

@ -1,16 +1,24 @@
# hkd: hotkey deamon
hkd allows to define system-wide hotkeys, independently of graphical environment,
this means, that hotkeys will work in x11 waylnad and even tty, as long as the
actions specified can run you are good to go.
this means, that hotkeys will work in x11, wayland and even in a tty.
## Compatibility
hkd only works in linux as it uses the linux-specific epoll and inotify apis
hkd only works on linux as it uses the linux-specific epoll and inotify APIs
as well as the evdev interface for input recognition.
## Compiling
hkd doesn't require any libraries and has no dependency other than a standard C
library, `musl` should work.\
run `make` to compile, `make clean` to remove the mess and `make debug` to compile
a debug binary to use with gdb.
library, `musl` should work too (altough I have not yet tested it).
Run `make` to compile, `make clean` to remove the mess and `make debug` to
compile a debug binary to use with gdb. To install run `make install` and
`make uninstall` if you re done with it.
## Documentation
The [man page](hkd.1) is (at least in my opinion) pretty simple and explanatory,
the program itself is very small (under 600 loc excluding comments and blanks)
and the config file is documented trough an [example](template.conf). That said
if I recive enough requests for further documentation I'll provide it.
## Similar projects
[triggerhappy](https://github.com/wertarbyte/triggerhappy)