summaryrefslogtreecommitdiffstats
path: root/keyboards/duck/jetfire/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-08-26 03:00:20 +0200
committerDrashna Jaelre <drashna@live.com>2018-08-26 03:00:20 +0200
commite16b39f0c20c73348ae12af0e82e4b4c0d30b393 (patch)
tree74d33ae10f38fb4fbb39ab2eaa298f9ecdd272cf /keyboards/duck/jetfire/readme.md
parenta68057852bbffc45f783523a86a6aa2e80a03d44 (diff)
downloadqmk_firmware-e16b39f0c20c73348ae12af0e82e4b4c0d30b393.tar.gz
qmk_firmware-e16b39f0c20c73348ae12af0e82e4b4c0d30b393.tar.xz
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
Diffstat (limited to 'keyboards/duck/jetfire/readme.md')
-rw-r--r--keyboards/duck/jetfire/readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/duck/jetfire/readme.md b/keyboards/duck/jetfire/readme.md
new file mode 100644
index 000000000..fb5baf975
--- /dev/null
+++ b/keyboards/duck/jetfire/readme.md
@@ -0,0 +1,18 @@
+# Jetfire
+
+![jetfire](imgur.com image replace me!)
+
+The Duck Jetfire is a hybrid full size and 1800 layout keyboard that went on
+Group Buy in November 2017.
+
+Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+Hardware Supported: Duck Jetfire PCB
+Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=92708.0)
+
+To get into bootloader mode, hold the top top most key above the 2 navigation keys while connecting the USB cable.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make jetfire: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.