summaryrefslogtreecommitdiff
path: root/keyboards/mechlovin/olly/octagon/readme.md
diff options
context:
space:
mode:
authormechlovin <57231893+mechlovin@users.noreply.github.com>2022-12-05 04:03:41 +0700
committerGitHub <noreply@github.com>2022-12-04 21:03:41 +0000
commit92354b2ca876b6b5dbcb5d34aa34fda6a473bb1a (patch)
treed532943a989652fb465e340b3097a4ee75c2c957 /keyboards/mechlovin/olly/octagon/readme.md
parentaf14b212b962ec455ec80f7527a919ae245bc2d9 (diff)
[Keyboard] Add Olly_Octagon PCB to QMK (#19128)
Co-authored-by: jack <0x6a73@protonmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/mechlovin/olly/octagon/readme.md')
-rw-r--r--keyboards/mechlovin/olly/octagon/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/mechlovin/olly/octagon/readme.md b/keyboards/mechlovin/olly/octagon/readme.md
new file mode 100644
index 0000000000..6f1833a571
--- /dev/null
+++ b/keyboards/mechlovin/olly/octagon/readme.md
@@ -0,0 +1,28 @@
+# Olly Octagon
+
+![Olly Octagon](https://i.imgur.com/lDMnyS4l.png)
+
+A replacement PCB for Duck Octagon 75% keyboard.
+
+* Keyboard Maintainer: [Mechlovin' Studio](https://github.com/mechlovin)
+* Hardware Supported: Duck Octagon, APM32F103
+* Hardware Availability: [Duck Octagon](https://geekhack.org/index.php?topic=102142.0)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mechlovin/olly/octagon:default
+
+Flashing example for this keyboard:
+
+ make mechlovin/olly/octagon: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 (Escape) and plug in the keyboard
+* **Bootloader reset**: Hold down the key at (0,14) in the matrix (Backspace) and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+* **Hardware reset**: Press reset button (located on the bottom side of the PCB)