summaryrefslogtreecommitdiff
path: root/keyboards/hineybush/h87_g2/readme.md
diff options
context:
space:
mode:
authorJosh Hinnebusch <joshhinnebusch@gmail.com>2023-03-15 12:43:06 -0400
committerGitHub <noreply@github.com>2023-03-15 10:43:06 -0600
commit0996bca9e96a598cf7b28b83550cf63aebf12393 (patch)
tree87f6bf8157c3425be23272d3e31dbc334f9b5f63 /keyboards/hineybush/h87_g2/readme.md
parentc18d5ebd2dff2615283931e2efe79cfdb2a550f2 (diff)
[Keyboard] Add hineybush/h87_g2 (#20053)
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: jack <0x6a73@protonmail.com>
Diffstat (limited to 'keyboards/hineybush/h87_g2/readme.md')
-rw-r--r--keyboards/hineybush/h87_g2/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/hineybush/h87_g2/readme.md b/keyboards/hineybush/h87_g2/readme.md
new file mode 100644
index 0000000000..0010c122af
--- /dev/null
+++ b/keyboards/hineybush/h87_g2/readme.md
@@ -0,0 +1,27 @@
+# h87_g2
+
+[h87_g2](https://i.imgur.com/t7chDf8h.png)
+
+New generation of the h87 keyboard PCB platform with an STM32 microcontroller.
+
+* Keyboard Maintainer: [Josh Hinnebusch](https://github.com/hineybush)
+* Hardware Supported: H87 G2 PCB w/ STM32F072 MCU
+* Hardware Availability: [hineybush.com](https://hineybush.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make hineybush/h87_g2:default
+
+Flashing example for this keyboard:
+
+ make hineybush/h87_g2: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