From 3a7e0addab9e7c5ce387fea651beb6fe7e622246 Mon Sep 17 00:00:00 2001
From: Paul <pvdstel@users.noreply.github.com>
Date: Sat, 2 Dec 2017 00:52:40 +0100
Subject: [PATCH] Add a readme file

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..093cadf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# virtual-media-keys
+
+Some [AutoHotkey](https://autohotkey.com/) scripts meant for people with
+keyboards without media keys. These scripts intercept some hotkeys and
+send media keys in their place.
+
+There are currently two flavors: arrow keys and navigation keys. The first
+one binds to the arrow keys, while the second one binds to navigation
+keys.
+
+| Command | Arrows | Navigation |
+|---------|--------|------------|
+| Play/pause | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>↑</kbd><br/><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>↓</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>PgUp</kbd><br/><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>PgDn</kbd> |
+| Previous | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>←</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Home</kbd> |
+| Next | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>→</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>End</kbd> |
+
+## Running / compiling
+
+The scripts can be executed directly using
+[AutoHotkey](https://autohotkey.com/). It also allows for compiling the
+scripts. Binary files attached to releases have been modified to use the
+complete icon set.