From e16b39f0c20c73348ae12af0e82e4b4c0d30b393 Mon Sep 17 00:00:00 2001
From: MechMerlin <30334081+mechmerlin@users.noreply.github.com>
Date: Sat, 25 Aug 2018 18:00:20 -0700
Subject: Keyboard: Duck Jetfire QMK Support (#3752)

* Initial Commit

Port from xauser's jetfire code. Does not compile yet

* fix up keymap from uint8 to uin16

* update rules file to contain custom matrix

* Good stopping point

Still lots of compile errors but I'm getting there.

* fix a few more compile errors

* move a few functions around to help with compiling

* Finally got it all to compile

* Get rid of that old KEYMAP macro

* edit readme

* Put my name everywhere and some minor code clean ups

* start to remove that kc nonsense

* fix keymap compilation issues

* add reset key info

* better human readable formatting

* match the duck default layout

* add confgurator support

* clarify reset key

* might be a good idea to use the correct pin

* get the riight keycode for RGB

* include an ALL layout

* I tried to fix the formatting....sigh

* add functons to ensure Configurator compile-ability

* move jetfire to duck directory

* Moved and renamed things as per Drashna's PR comments as his back was hurting as he reviewed this
---
 keyboards/duck/readme.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 keyboards/duck/readme.md

(limited to 'keyboards/duck/readme.md')

diff --git a/keyboards/duck/readme.md b/keyboards/duck/readme.md
new file mode 100644
index 0000000000..caf7e156d1
--- /dev/null
+++ b/keyboards/duck/readme.md
@@ -0,0 +1,16 @@
+# Duck Keyboards
+
+[Duck](http://duck0113.tistory.com/) is a popular Korean custom keyboard designer.  
+Duck boards can only be bought new during a Group Buy and are commonly on a first come, first serve basis. 
+
+**QMK is not the official firmware for Duck Keyboards.** 
+
+For the official firmware, please use [OTD](http://kbdlab.co.kr/index.php?document_srl=100301&mid=board_sw).
+
+## QMK Powered Duck Boards
+Eagle V2  
+Jetfire V1  
+Lightsaver V3  
+Octagon V1  
+Octagon V2  
+Viper V2  
\ No newline at end of file
-- 
cgit v1.2.3