summaryrefslogtreecommitdiff
path: root/keyboards/frosty_flake/readme.md
diff options
context:
space:
mode:
authorJason Milkins <jasonm23@users.noreply.github.com>2017-09-07 08:42:19 +0800
committerskullydazed <skullydazed@users.noreply.github.com>2017-09-06 17:42:19 -0700
commit43a1ea30355bb31248ba54522f8eee1cd0db8754 (patch)
tree0664961f50ab63b3a6fbeac95f2d62938ae55cd1 /keyboards/frosty_flake/readme.md
parentaf14e672c9c82b4a906ab9e3eae649d96158d2bd (diff)
Add TKL keymap for Frosty_Flake (#1666)
* Add TKL keymap for Frosty_Flake * Update readme.md * Add spaces for ghfm newlines * add note for dfu target
Diffstat (limited to 'keyboards/frosty_flake/readme.md')
-rw-r--r--keyboards/frosty_flake/readme.md48
1 files changed, 39 insertions, 9 deletions
diff --git a/keyboards/frosty_flake/readme.md b/keyboards/frosty_flake/readme.md
index 762eeab3a2..4a933d0bd6 100644
--- a/keyboards/frosty_flake/readme.md
+++ b/keyboards/frosty_flake/readme.md
@@ -1,16 +1,46 @@
-Frosty Flake Controller
-===
+# Frosty Flake Controller
-This is the firmware for Rev. 20140521 of the Frosty Flake controller by [Bathroom Epiphanies](http://bathroomepiphanies.com/controllers/), a replacement controller for the [Cooler Master Quick Fire Rapid](http://www.coolermaster.com/peripheral/keyboards/quickfirerapid/).
+This is the firmware for Rev. 20140521 of the Frosty Flake controller
+by [Bathroom Epiphanies](http://bathroomepiphanies.com/controllers/),
+a replacement controller for the [Cooler Master Quick Fire
+Rapid](http://www.coolermaster.com/peripheral/keyboards/quickfirerapid/).
-The code was adapted from the [BathroomEpiphanies TMK Firmware](https://github.com/BathroomEpiphanies/epiphanies_tmk_keyboard/tree/master/be_controllers), but has been cleaned up to match the [schematic](https://deskthority.net/wiki/File:Frosty_Flake_Schematics.pdf) and gone through some minor refactoring for QMK.
+The code was adapted from the [BathroomEpiphanies TMK
+Firmware](https://github.com/BathroomEpiphanies/epiphanies_tmk_keyboard/tree/master/be_controllers),
+but has been cleaned up to match the
+[schematic](https://deskthority.net/wiki/File:Frosty_Flake_Schematics.pdf)
+and gone through some minor refactoring for QMK.
-Keyboard Maintainer: QMK Community
-Hardware Supported: Frosty Flake
-Hardware Availability: https://1upkeyboards.com/qfr-frosty-flake-controller.html
+## 104 and 87 layout support
+
+Support for both 104 key and 87 key layouts is provided. See the
+keymaps `default` (104) and `tkl` (87) for example layouts.
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: Frosty Flake
+Hardware Availability: https://1upkeyboards.com/qfr-frosty-flake-controller.html
Make example for this keyboard (after setting up your build environment):
- make frosty_flake-default
+104 key default layout:
+
+```
+make frosty_flake-default
+```
+
+To directly flash the frosty_flake after compiling use
+
+```
+make frosty_flake-default-dfu
+```
+
+87 key tkl layout:
+
+```
+make frosty_flake-tkl-dfu
+```
-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.
+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.