diff options
author | scott-t-wilson <scott.t.wilson@gmail.com> | 2018-02-23 13:16:10 -0500 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2018-02-23 13:16:10 -0500 |
commit | 3f3d0551cd5f2ca0b72fc4b24d1d7955ffa8cb78 (patch) | |
tree | 0abed9c5a39693745060f75606f67771051f041c /keyboards/lfkeyboards/lfkpad/readme.md | |
parent | f7461748744c1e3a5bae3b7a54d5b0d8439606e6 (diff) |
Lfkeyboards updates (#2421)
* Update smk65 fn layer, add iso
* Added Fn layer to ISO keymap
* Fix error when backlight is disabled but lighting isn't
* Remove broke mini1800 iso map
* Add keymaps
* Add LFKPad
* Add split delete to lfk78
* Typo
* Custom keymap
Diffstat (limited to 'keyboards/lfkeyboards/lfkpad/readme.md')
-rw-r--r-- | keyboards/lfkeyboards/lfkpad/readme.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/lfkeyboards/lfkpad/readme.md b/keyboards/lfkeyboards/lfkpad/readme.md new file mode 100644 index 0000000000..5f23d988a0 --- /dev/null +++ b/keyboards/lfkeyboards/lfkpad/readme.md @@ -0,0 +1,28 @@ +bluepad keyboard firmware +====================== + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). + +## Building + +Download or clone the whole firmware and navigate to the keyboards/bluepad 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`. + +### 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 `keymap` option like: + +``` +$ make keymap=[default|jack|<name>] +``` + +Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` |