Firmware: Add initial QMK firmware files

README.md

@@ -6,6 +6,7 @@ Custom macro key pad with mechanical low-profile (Choc) switches.
 
 - `/layouts`: Keyboard layouts created with the [Keyboard Layout Editor](http://www.keyboard-layout-editor.com)
 - `/ergogen`: [Ergogen](https://docs.ergogen.xyz/) files to generate outlines, cases and PCBs
+- `/qmk_keyboards`: [QMK](https://qmk.fm/) keyboard files to compile and flash the QMK firmware
 
 ## How-to
 
@@ -75,6 +76,26 @@ Now you can generate the gerber, drill and map files.
 4. Upload zip file to manufacturer and make sure everything is correct.
 5. Add all generated files to version control (the zip should be on gitignore).
 
+### Compile and flash QMK firmware
+
+To compile the QMK firmware, you first need the `qmk` CLI and a local copy of the QMK firmware.
+
+1. [Install](https://docs.qmk.fm/#/cli) the `qmk` CLI using your favorite package manager.
+2. Run `qmk setup` to clone a local copy of the QMK firmware. (By default in `~/qmk_firmware`, feel free to adjust.)
+
+The firmware for this keyboard is compiled using the local copy of QMK and the keyboard definitions in `qmk_keyboards`
+which are automatically symlinked to your installed QMK firmware directory (defaults to `~/qmk_firmware`, can be
+overridden by setting `QMK_HOME` in your environment). A Makefile is provided to simplify compiling and flashing.
+
+To compile and flash the firmware, run `make qmk-flash`.
+
+After compiling the firmware, you will be asked to put your keyboard into bootloader mode. This can be done either by
+pressing the reset button on the backside of the keyboard, or by using the `QK_BOOTLOADER` keycode which is mapped to
+the key combination `0,4 (hold) + 0,0` (these are the matrix coordinates).
+
+You can also run `make qmk-activate` which will run `qmk config` to set `user.keyboard` and `user.keymap` to this
+keyboard. This allows you to use the `qmk` CLI directly without specifying the keyboard and keymap everytime.
+
 ## Used software
 
 - [Keyboard Layout Editor](http://www.keyboard-layout-editor.com)
@@ -82,7 +103,9 @@ Now you can generate the gerber, drill and map files.
 - [KiCad](https://www.kicad.org/)
 - [FreeCAD](https://www.freecad.org/)
 - [UltiMaker Cura](https://ultimaker.com/software/ultimaker-cura/)
+- [QMK](https://qmk.fm/) 
 
 ## Resources
 
 - [FlatFootFox's Ergogen tutorial](https://flatfootfox.com/ergogen-introduction/)
+- [QMK documentation](https://docs.qmk.fm/)