diff options
Diffstat (limited to 'keyboards/frosty_flake/readme.md')
| -rw-r--r-- | keyboards/frosty_flake/readme.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/keyboards/frosty_flake/readme.md b/keyboards/frosty_flake/readme.md new file mode 100644 index 000000000..ff440e33b --- /dev/null +++ b/keyboards/frosty_flake/readme.md | |||
| @@ -0,0 +1,32 @@ | |||
| 1 | frosty_flake keyboard firmware | ||
| 2 | ====================== | ||
| 3 | |||
| 4 | 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/). | ||
| 5 | |||
| 6 | 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. | ||
| 7 | |||
| 8 | ## Quantum MK Firmware | ||
| 9 | |||
| 10 | For the full Quantum feature list, see [the parent readme](/). | ||
| 11 | |||
| 12 | ## Building | ||
| 13 | |||
| 14 | 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. | ||
| 15 | |||
| 16 | Depending on which keymap you would like to use, you will have to compile slightly differently. | ||
| 17 | |||
| 18 | ### Default | ||
| 19 | |||
| 20 | To build with the default keymap, simply run `make default`. | ||
| 21 | |||
| 22 | ### Other Keymaps | ||
| 23 | |||
| 24 | 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. | ||
| 25 | |||
| 26 | To build the firmware binary hex file with a keymap just do `make` with a keymap like this: | ||
| 27 | |||
| 28 | ``` | ||
| 29 | $ make [default|jack|<name>] | ||
| 30 | ``` | ||
| 31 | |||
| 32 | Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. | ||
