From e9f80e8200215e4bb562d9850aca0cc6d2580f42 Mon Sep 17 00:00:00 2001
From: Alessandro Mauri <alemauri001@gmail.com>
Date: Sat, 25 Apr 2020 23:10:47 +0200
Subject: [PATCH] first readme

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index e69de29..142b52e 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,16 @@
+# 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.
+
+## Compatibility
+hkd works using the evdev interface so the following systems work:
+* linux
+* FreeBSD
+* dragonflyBSD
+
+## 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.