summaryrefslogtreecommitdiff
path: root/keyboards/cannonkeys/is0gr/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@gmail.com>2023-09-24 22:59:38 -0400
committerGitHub <noreply@github.com>2023-09-25 12:59:38 +1000
commitc10a46aa436fdd55279bf5b78cc5b9b54c90ca56 (patch)
tree423bd9950c96804d132dffca7f9fbeaa83423020 /keyboards/cannonkeys/is0gr/readme.md
parente3cbd8a9650a9e85be5c2d90ed21686863382376 (diff)
Add is0gr to QMK (#22024)
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>
Diffstat (limited to 'keyboards/cannonkeys/is0gr/readme.md')
-rw-r--r--keyboards/cannonkeys/is0gr/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/is0gr/readme.md b/keyboards/cannonkeys/is0gr/readme.md
new file mode 100644
index 0000000000..f6fb2b8f61
--- /dev/null
+++ b/keyboards/cannonkeys/is0gr/readme.md
@@ -0,0 +1,24 @@
+# Alchemist Keyboards is0GR
+
+is0GR Keyboard
+
+Keyboard Maintainer: [Andrew Kannan](https://github.com/awkannan)
+Hardware Supported: STM32F072CBT6 or equivalent
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cannonkeys/is0gr:default
+
+Flashing example for this keyboard:
+
+ make cannonkeys/is0gr: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 (on this board - it's the only key) and plug in the keyboard
+* **Physical reset button**: Bridge the two pads labeled "RESET" on the top of the PCB using some tweezers, and hold the tweezers there until the board enters the bootloader mode
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available (it isn't by default)