summaryrefslogtreecommitdiffstats
path: root/keyboards/cannonkeys/ellipse_hs/readme.md
diff options
context:
space:
mode:
authorDrashna Jael're <drashna@live.com>2022-10-24 23:28:56 -0700
committerDrashna Jael're <drashna@live.com>2022-10-24 23:28:56 -0700
commiteeb3f9c04346da4f387f1beb439f558a82fcb95c (patch)
tree7b997f5a62d862dac576bb04eb49a1023ef5af0c /keyboards/cannonkeys/ellipse_hs/readme.md
parente3594135012aa8c8bc309bf43aaa958f3135a30a (diff)
parentf100de88e524633d4f7b35602b37ad6a76044f1d (diff)
Merge remote-tracking branch 'origin/master' into develop
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