summaryrefslogtreecommitdiff
path: root/keyboards/octagon/v1/readme.md
diff options
context:
space:
mode:
authorMechMerlin2017-12-20 16:54:07 -0800
committerJack Humbert2017-12-20 19:54:07 -0500
commitc68597d9ad983c7d8f2b857f795037f2a441522d (patch)
tree1203027cb39d3dab4ab01f780c06ce7d46699ba8 /keyboards/octagon/v1/readme.md
parent5ffec5d9b09333173d85abb228f38225388938ca (diff)
Octagon V1 Support (Port) (#2184)
* Preliminary commit for Octagon V1 support This is essentially a cp -R v2 v1 with a few things changed to get it to compile and build. * The Octagon V1 supports up to 84 keys as opposed to the V2 which supports up to 86. This commit changes the keymap to match it. * Temporary default keymap just to get things to compile * Update readme file * Fix switch matrix * Fix underglow lighting option * Fix keymap to take care of shifted columns * Fix keymap formatting * Remove un-needed files left over from rasmusx * Make Octagon V1 have its own keymap directory with default keymap * Make Octagon V2 have its own keymap directory with default keymap * Cleanups and readme edits
Diffstat (limited to 'keyboards/octagon/v1/readme.md')
-rw-r--r--keyboards/octagon/v1/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/octagon/v1/readme.md b/keyboards/octagon/v1/readme.md
new file mode 100644
index 000000000..72285b1ed
--- /dev/null
+++ b/keyboards/octagon/v1/readme.md
@@ -0,0 +1,28 @@
+# Duck Octagon V1
+
+Non official firmware for custom Korean keyboard with 75% key layout made by Duck.
+Group buy was run October 2014 via [geekhack](https://geekhack.org/index.php?topic=65036.0) 35 keyboards total.
+
+Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+Hardware Supported: Duck Octagon PCB Ver 1.0, Atmega32u4
+Hardware Availability: Wait until GB of the next revision
+
+Make example for this keyboard (after setting up your build environment):
+
+ make octagon/v1:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+
+## Hardware Notes
+
+The Duck Octagon V1 PCB consists of:
+
+### Microchips
+2 74HC237D 3-to-8 line decoders
+1 Atmega32u4 microcontroller
+2 WS2811 LED controller
+
+## Notes
+Thanks to Ralf Schmitt for previous implementations in his [TMK fork](https://github.com/xauser/tmk_keyboard/tree/xauser/) and few helping words.
+
+Based heavily on Rasmus Schults [Duck Lightsaver QMK Port](https://github.com/qmk/qmk_firmware/tree/master/keyboards/lightsaver)