summaryrefslogtreecommitdiff
path: root/keyboards/gopolar/gg86/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/gopolar/gg86/readme.md')
-rw-r--r--keyboards/gopolar/gg86/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/gopolar/gg86/readme.md b/keyboards/gopolar/gg86/readme.md
new file mode 100644
index 0000000000..169d7e1904
--- /dev/null
+++ b/keyboards/gopolar/gg86/readme.md
@@ -0,0 +1,24 @@
+# Gopolar GG86 Tai-Chi
+
+![GG86 Tai-Chi](https://i.imgur.com/SgXOZjt.png?2)
+
+A tenkeyless 86-key keyboard made by Gopolar, which controlled by an Atmega32u4 chipset. The keyboard features per-key RGB as well as underglow RGB, and an OLED screen for displaying useful information.
+
+* Keyboard Maintainer: Gopolar
+* Hardware Supported: Atmega32u4
+* Hardware Availability: [mecha.store](https://mecha.store/collections/gopolar/products/gopolar-gg86-tenkeyless-hotswappable-barebones-keyboard) / [AliExpress](https://www.aliexpress.com/item/1005003605711613.html)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make gopolar/gg86:default
+
+Flashing example for this keyboard:
+
+ make gopolar/gg86: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
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (Esc key) and plug in the keyboard
+* **Physical reset button**: Short press the button under Spacebar keycap to enter the Bootloader and flash the firmware
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available