From 2fe55eabfeb8d79ec264408be03c789b46b7b145 Mon Sep 17 00:00:00 2001 From: Cian Hughes Date: Thu, 23 Jan 2025 15:00:05 +0000 Subject: [PATCH] Updated readme.md to with install instructions and warning about breakage --- readme.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index ce100ea3d3..09e1983816 100644 --- a/readme.md +++ b/readme.md @@ -3,8 +3,16 @@ My personal fork of the QMK project for the purposes of defining my own custom k # Installation 1. Build the firmware ```sh -qmk compile -kb splitkb/kyria/rev3 -km my_kyria_layout +poetry install +poetry run ./compile_my_layout.sh ``` +2. Disconnect all wires from keyboard, hold button on kb half while connecting USB. +3. Drag-and-drop .uf2 file onto kb storage. +4. Repeat for other kb half + +> [!WARNING] +> The current version of this software is broken due to issue [#24725](https://github.com/qmk/qmk_firmware/issues/24725). It will not be able to be compiled to a .uf2 file until this issue is fixed. # Keymap + ![My keymap](https://github.com/Cian-H/qmk_firmware/blob/master/keymap.svg)