aboutsummaryrefslogtreecommitdiff
path: root/keyboards/handwired/riblee_split/readme.md
diff options
context:
space:
mode:
authorQMK Bot <[email protected]>2023-11-08 08:31:41 +0000
committerQMK Bot <[email protected]>2023-11-08 08:31:41 +0000
commit2be22a1323598e80e3359f92ddd0f90aac46e623 (patch)
tree72c7647a365b71e2845df95029fdcf606109f5d5 /keyboards/handwired/riblee_split/readme.md
parent884f653906ebe594b9433c0d882969a0feb9770b (diff)
parent2337cd1186e6a7b3f085cdafac5c1da87074015b (diff)
downloadqmk_firmware-2be22a1323598e80e3359f92ddd0f90aac46e623.tar.gz
qmk_firmware-2be22a1323598e80e3359f92ddd0f90aac46e623.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/handwired/riblee_split/readme.md')
-rw-r--r--keyboards/handwired/riblee_split/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/handwired/riblee_split/readme.md b/keyboards/handwired/riblee_split/readme.md
new file mode 100644
index 0000000000..b0acf5b3ba
--- /dev/null
+++ b/keyboards/handwired/riblee_split/readme.md
@@ -0,0 +1,24 @@
+# Handwired Split
+
+This is a compact (12x5) ortholinear split keyboard.
+
+* Keyboard Maintainer: [Daniel Reibl](https://github.com/riblee)
+* Hardware Supported: STM32F411 BlackPill
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/riblee_split:default
+
+Flashing example for this keyboard:
+
+ make handwired/riblee_split:default:flash
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available