diff options
author | Gabriel Young <[email protected]> | 2017-03-18 15:38:03 -0700 |
---|---|---|
committer | Gabriel Young <[email protected]> | 2017-03-18 15:38:03 -0700 |
commit | 3766f902a02da7e9355685c733f70bcff9fe5a12 (patch) | |
tree | 9762efcad6e58fa404936d7b375ce7584fe28226 /keyboards/frosty_flake/readme.md | |
parent | 70d83afff9c9074eeec3407c591b8683ccd82ef9 (diff) | |
download | qmk_firmware-3766f902a02da7e9355685c733f70bcff9fe5a12.tar.gz qmk_firmware-3766f902a02da7e9355685c733f70bcff9fe5a12.zip |
boilerplate project created with new_project.sh
Diffstat (limited to 'keyboards/frosty_flake/readme.md')
-rw-r--r-- | keyboards/frosty_flake/readme.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/frosty_flake/readme.md b/keyboards/frosty_flake/readme.md new file mode 100644 index 0000000000..a329650619 --- /dev/null +++ b/keyboards/frosty_flake/readme.md @@ -0,0 +1,28 @@ +frosty_flake keyboard firmware +====================== + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent readme](/). + +## Building + +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. + +Depending on which keymap you would like to use, you will have to compile slightly differently. + +### Default + +To build with the default keymap, simply run `make default`. + +### Other Keymaps + +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. + +To build the firmware binary hex file with a keymap just do `make` with a keymap like this: + +``` +$ make [default|jack|<name>] +``` + +Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. |