From 1cceccf2873adcdf3411a8e9c086aa41ba4f61d1 Mon Sep 17 00:00:00 2001
From: Adam Kruszewski <adam@noreply.example.org>
Date: Wed, 1 Jul 2020 13:46:26 +0000
Subject: [PATCH] Expand README file

---
 readme.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index 8fa8ddf..8a37f85 100644
--- a/readme.md
+++ b/readme.md
@@ -1 +1,34 @@
-# The default keymap for Redox
+# Colemak mod_DH keymap for Redox (rev 1, wired)
+
+Customized Colemak DH keyboard layout. It does come with additional QWERTY layout (no 4) for those rare occasions when needed. 
+
+Upload `colemak-dh-1.json` to https://config.qmk.fm/#/redox/rev1/LAYOUT to
+see the layout (and preferably print it when learning).
+
+## How to flash the firmware
+
+Download QMK Firmware (https://docs.qmk.fm/#/getting_started_build_tools) and decompess/install according to instructions.
+
+Place content of the repsitory in:
+
+`qmk_firmware/keyboards/redox/keymaps/adam-colemak`
+
+next regenerate keymap.c from json layout (you can modify the json file using graphical configurator linked above):
+
+`qmk json2c colemak-dh-1.json -o keymap.c`
+
+compile the firmware:
+
+```
+qmk config user.keyboard=redox/rev1
+qmk config user.keymap=adam-colemak
+qmk compile
+```
+
+and finally flash to your keyboard (you will need to run flash command for each side of the keyboard separately):
+
+```
+qmk flash
+```
+
+Enjoy!
\ No newline at end of file