summaryrefslogtreecommitdiff
path: root/keyboards/gmmk/pro/readme.md
diff options
context:
space:
mode:
authorSalman <74627436+GloriousThrall@users.noreply.github.com>2021-03-17 17:33:16 -0500
committerGitHub <noreply@github.com>2021-03-18 09:33:16 +1100
commitcc84831cae1d1f7159aea3bc03001a6293d43ee7 (patch)
treee80f9d8eda70da598a438c8cc2557c80bfd7bf82 /keyboards/gmmk/pro/readme.md
parentf490777502fb5af088b4ec2a1bf93ac61b95b59a (diff)
Adding Keyboard: GMMK Pro (#12030)
* GMMK Pro QMK Firmware Code * info.json added * updated info.json for the unused keys * redoing info.json * readme for pro * gmmk initial readme * pipeline fix, issue with compiling gmmk.h * gmmk pro code formatting changes * removed rules.mk * noci file * Updates * updated matrix function to match keymap * updating the keymap layout, renaming matrix, updating layout name to LAYOUT * fauxpark changes added * PID VID updates * removed chconfig and made rules.mk comments cleaner Co-authored-by: Drashna Jael're <drashna@live.com>
Diffstat (limited to 'keyboards/gmmk/pro/readme.md')
-rw-r--r--keyboards/gmmk/pro/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/gmmk/pro/readme.md b/keyboards/gmmk/pro/readme.md
new file mode 100644
index 0000000000..32510a7ff8
--- /dev/null
+++ b/keyboards/gmmk/pro/readme.md
@@ -0,0 +1,13 @@
+# GMMK PRO
+
+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:default
+
+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).