summaryrefslogtreecommitdiff
path: root/keyboards/gmmk/pro/iso/readme.md
diff options
context:
space:
mode:
authorGigahawk <jasperchan515@gmail.com>2021-07-19 17:57:19 -0700
committerGitHub <noreply@github.com>2021-07-19 17:57:19 -0700
commitb994921703190886714a4b2df2a674265e586b59 (patch)
treef5a060e4eef136b653ab3996fcb8b2ecdff9d1c8 /keyboards/gmmk/pro/iso/readme.md
parent5753226588fb453657e7c99b7b19beb8d325f0e0 (diff)
[Keyboard] Split GMMK Pro PCBs into separate revisions (#13570)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/gmmk/pro/iso/readme.md')
-rw-r--r--keyboards/gmmk/pro/iso/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/gmmk/pro/iso/readme.md b/keyboards/gmmk/pro/iso/readme.md
new file mode 100644
index 0000000000..3f255c490e
--- /dev/null
+++ b/keyboards/gmmk/pro/iso/readme.md
@@ -0,0 +1,23 @@
+# GMMK PRO (ISO)
+
+A tenkeyless 75% keyboard made and sold by Glorious LLC. Equipped with the STM32 ARM Cortex-M4 microcontroller, with support for rotary encoders and three additional layouts. [More info at Glorious](https://www.pcgamingrace.com/products/glorious-gmmk-pro-75-barebone-black-reservation)
+
+* Keyboard Maintainer: [GloriousThrall](https://github.com/GloriousThrall)
+* Hardware Supported: GMMK Pro
+* Hardware Availability: [GloriousPCGaming.com](https://www.pcgamingrace.com/products/glorious-gmmk-pro-75-barebone-black-reservation)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make gmmk/pro/iso:default
+
+Flashing example for this keyboard:
+
+ make gmmk/pro/iso:default:flash
+
+To reset the board into bootloader mode, do one of the following:
+
+* Hold the Reset switch mounted on the bottom side of the PCB while connecting the USB cable
+* Hold the Escape key while connecting the USB cable (also erases persistent settings)
+* Fn+Backspace will reset the board to bootloader mode if you have flashed the default QMK keymap
+
+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).