summaryrefslogtreecommitdiff
path: root/keyboards/cannonkeys/ellipse_hs/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@klaviyo.com>2022-10-25 01:05:22 -0400
committerGitHub <noreply@github.com>2022-10-24 22:05:22 -0700
commitd861a35ebf0b067a1cc4d7fce3d09b16462a078d (patch)
treeca1741a01d12b1c02d41bbbb781469ac94956e6f /keyboards/cannonkeys/ellipse_hs/readme.md
parent67fd4e6b7afe5515b67f153723f57beabbebe25e (diff)
[Keyboard] Add Ellipse hotswap PCB support (#18707)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/cannonkeys/ellipse_hs/readme.md')
-rw-r--r--keyboards/cannonkeys/ellipse_hs/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/ellipse_hs/readme.md b/keyboards/cannonkeys/ellipse_hs/readme.md
new file mode 100644
index 0000000000..e516ee49e3
--- /dev/null
+++ b/keyboards/cannonkeys/ellipse_hs/readme.md
@@ -0,0 +1,25 @@
+# Ellipse Hotswap
+
+*A ellipse inspired 60% keyboard with 3 mounting styles from Skepur*
+
+* Keyboard Maintainer: [Andrew Kannan](https://github.com/awkannan)
+* Hardware Supported: STM32F072CBT6
+* Hardware Availability: [CannonKeys](https://cannonkeys.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cannonkeys/ellipse_hs:default
+
+Flashing example for this keyboard:
+
+ make cannonkeys/ellipse_hs: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**: Swap the boot switch on the back of the PCB to "1" and hit the reset button
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available