Add TKL keymap for Frosty_Flake (#1666)

[qmk_firmware.git] / keyboards / frosty_flake / readme.md

diff --git a/keyboards/frosty_flake/readme.md b/keyboards/frosty_flake/readme.md
index ff440e33b60e18b1078c9a36f86766f99d22ff43..4a933d0bd6c9482b80bfb2a77de616f4f34a9f5a 100644 (file)
--- a/keyboards/frosty_flake/readme.md
+++ b/keyboards/frosty_flake/readme.md
@@ -1,32 +1,46 @@
-frosty_flake keyboard firmware
-======================
+# 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.
 
-## Quantum MK Firmware
+## 104 and 87 layout support
 
-For the full Quantum feature list, see [the parent readme](/).
+Support for both 104 key and 87 key layouts is provided. See the
+keymaps `default` (104) and `tkl` (87) for example layouts.
 
-## Building
+Keyboard Maintainer: QMK Community  
+Hardware Supported: Frosty Flake  
+Hardware Availability: https://1upkeyboards.com/qfr-frosty-flake-controller.html  
 
-Download or clone the whole firmware and navigate to the keyboards/frosty_flake folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. 
+Make example for this keyboard (after setting up your build environment):
 
-Depending on which keymap you would like to use, you will have to compile slightly differently.
+104 key default layout:
 
-### Default
-
-To build with the default keymap, simply run `make default`.
+```
+make frosty_flake-default
+```
 
-### Other Keymaps
+To directly flash the frosty_flake after compiling use
 
-Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files.
+```
+make frosty_flake-default-dfu
+```
 
-To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
+87 key tkl layout:
 
 ```
-$ make [default|jack|<name>]
+make frosty_flake-tkl-dfu
 ```
 
-Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
+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.