Add QMK firmware for rev1

README.md

@@ -2,6 +2,14 @@
 
 Custom ergonomic mechanical keyboard with low-profile (Choc) switches.
 
+## Versions
+
+- **eepyBoard v1.0: Hardware revision 1**
+  - Mostly ortholinear layout with 13 columns
+  - Bottom row: two regular keys + four thumb keys (per side, symmetrical)
+  - Partial F-key row (Esc, F1-F8) and rotary encoder
+  - RP2040 controller board in upper right corner
+
 ## Repository structure
 
 - `/layouts`: Keyboard layouts created with the [Keyboard Layout Editor](http://www.keyboard-layout-editor.com)
@@ -78,7 +86,30 @@ Now you can generate the gerber, drill and map files.
 
 ### Compile and flash QMK firmware
 
-TODO: Add this when building the 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 in multiple
+ways:
+
+- Hold the BOOTSEL button on the controller board while pressing the reset button (or while plugging in the cable).
+- Hold the Escape key while pressing the reset button / plugging in the cable.
+- Press the key combination that is mapped to the `QK_BOOTLOADER` keycode (currently Fn + Right Ctrl).
+
+The RP2040 uses UF2 as the default bootloader. This bootloader works by emulating a USB storage device that the firmware
+file can be copied on. After putting the RP2040 into bootloader mode, you need to mount the USB storage device (doesn't
+matter where). For convenience, it is recommended to enable auto-mounting in your system, e.g. using `udiskie`.
+
+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