summaryrefslogtreecommitdiff
path: root/keyboards/octagon_v2/readme.md
diff options
context:
space:
mode:
authorMechMerlin2017-12-14 21:09:31 -0800
committerJack Humbert2017-12-15 00:09:31 -0500
commit163ddd5d155d8403cf41bea6465e21b59dba9e0f (patch)
tree7b02b51f6bc5adbc3c6d5cf875b29b48ce98e701 /keyboards/octagon_v2/readme.md
parentdc7cc26dff01cc84b6f9f96af6d3aa03469aaca3 (diff)
Duck Octagon V2 QMK Support (#2153)
* Initial commit for Octagon V2 Support This is still basically just a copy of lightsaver support with names changed. * Port xauser keymap from: https://github.com/xauser/tmk_keyboard/blob/xauser/keyboard/octagon_v2/keymap_common.h * Temporary default keymap just to get things compiling * Modify config.h to have the right keyboard info * Partial port of xauser matrix code for octagon v2 * Fix readme.md 1. Fix link to geekhack GB 2. Add microchips 3. Add appropriate attributions * Fix PORTD * Intermediate fix to get LEDs working * Update BACKLIGHT_AREAS enum * Port the following: backlight_set backlight_toggle_rgb backlight_set_rgb and resolve dependencies in header files * Port backlight_update_state to led_set_kb * Change copyright notice author to MechMerlin * Remove Rasmus keymap * Get a default keymap that actually does something and let's you reset. * Convert keymap into KC_XXXX format. * Better formatting of the default keymap to make it more readable * Fix keymap * Get that Fn key working! * Some code cleanup and small refactor * Fix keymap in octagon_v2.h
Diffstat (limited to 'keyboards/octagon_v2/readme.md')
-rw-r--r--keyboards/octagon_v2/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/octagon_v2/readme.md b/keyboards/octagon_v2/readme.md
new file mode 100644
index 000000000..37783c84c
--- /dev/null
+++ b/keyboards/octagon_v2/readme.md
@@ -0,0 +1,28 @@
+# Duck Octagon V2
+
+Non official firmware for custom Korean keyboard with 75% key layout made by Duck.
+Group buy was run January 2016 via [geekhack](https://geekhack.org/index.php?topic=78549.0) with 2 rounds, 100 keyboards total.
+
+Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+Hardware Supported: Duck Octagon PCB Ver 2.0, Atmega32u4
+Hardware Availability: Wait until GB of the next revision
+
+Make example for this keyboard (after setting up your build environment):
+
+ make octagon_v2: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 V2 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) \ No newline at end of file