summaryrefslogtreecommitdiff
path: root/keyboards/kibou/harbour/readme.md
diff options
context:
space:
mode:
authorFanXingStudio <133078117+FanXingStudio@users.noreply.github.com>2023-06-06 13:13:47 +0800
committerGitHub <noreply@github.com>2023-06-05 23:13:47 -0600
commit9167e66ca7a8293748df7349493ecc972ac6cb4b (patch)
tree73fa188071646399e103492580e8a827e4f13e2f /keyboards/kibou/harbour/readme.md
parent04812e944314fb4d894aa9a53a366f32337fc4d6 (diff)
[Keyboard] add kibou/harbour (#21131)
Diffstat (limited to 'keyboards/kibou/harbour/readme.md')
-rw-r--r--keyboards/kibou/harbour/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/kibou/harbour/readme.md b/keyboards/kibou/harbour/readme.md
new file mode 100644
index 0000000000..f957e31795
--- /dev/null
+++ b/keyboards/kibou/harbour/readme.md
@@ -0,0 +1,23 @@
+# harbour
+
+* Keyboard Maintainer: [kibou](https://kibou.store/)
+* Hardware Supported: harbour PCBs, STM32F401
+* Hardware Availability: https://kibou.store/
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kibou/harbour:default
+
+Flashing example for this keyboard:
+
+ make kibou/harbour: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