summaryrefslogtreecommitdiff
path: root/keyboards/heliotrope/readme.md
diff options
context:
space:
mode:
authorMJM <89230047+MATTMCCA@users.noreply.github.com>2022-12-10 21:35:06 -0500
committerGitHub <noreply@github.com>2022-12-10 18:35:06 -0800
commit57351e4a37d0b598e6019a7e051560481f9a2576 (patch)
tree20dfd6c253d145dabf00df12fef154c981172fb9 /keyboards/heliotrope/readme.md
parent143b7a3c3dc3bb3474222119054a5f1979832862 (diff)
[Keyboard] Add heliotrope Keyboard (#19170)
Diffstat (limited to 'keyboards/heliotrope/readme.md')
-rw-r--r--keyboards/heliotrope/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/heliotrope/readme.md b/keyboards/heliotrope/readme.md
new file mode 100644
index 0000000000..930f1555c6
--- /dev/null
+++ b/keyboards/heliotrope/readme.md
@@ -0,0 +1,24 @@
+# heliotrope
+
+* Keyboard Maintainer: [MATTMCCA](https://github.com/MATTMCCA)
+* Hardware Supported: *https://github.com/MATTMCCA/Heliotrope/*
+* Hardware Availability: *https://github.com/MATTMCCA/Heliotrope/*
+
+Make example for this keyboard (after setting up your build environment):
+
+ make heliotrope:default
+
+Flashing example for this keyboard:
+
+ make heliotrope: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
+