Cian-H/qmk_firmware
1
0
Fork 0
mirror of https://github.com/Cian-H/qmk_firmware.git synced 2025-12-22 14:11:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme.md to with install instructions and warning about breakage

Browse Source
This commit is contained in:
Cian Hughes
2025-01-23 15:00:05 +00:00
parent 408d2c6bba
commit 2fe55eabfe
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
readme.md
View File

@@ -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)