diff options
| author |  fauxpark <fauxpark@gmail.com> | 2020-02-05 13:41:19 +1100 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2020-02-04 18:41:19 -0800 |
| commit | efe8bd8e9218f67a0845ccfa3eef7b074aebf7dc (patch) | |
| tree | 798b25c2b1bcb3c5a2982e748a95d947416da3e2 /keyboards/lfkeyboards/lfkpad/readme.md | |
| parent | 74e3cad72829f673b6398dc18257f9d05bdaa3fe (diff) | |
| download | qmk_firmware-efe8bd8e9218f67a0845ccfa3eef7b074aebf7dc.tar.gz | |
[Keyboard] LFKPad refactor (#8079)
Diffstat (limited to 'keyboards/lfkeyboards/lfkpad/readme.md')
| -rw-r--r-- | keyboards/lfkeyboards/lfkpad/readme.md | 31 |
1 files changed, 9 insertions, 22 deletions
diff --git a/keyboards/lfkeyboards/lfkpad/readme.md b/keyboards/lfkeyboards/lfkpad/readme.md index 7dd8337e8..ce5e7f67b 100644 --- a/keyboards/lfkeyboards/lfkpad/readme.md +++ b/keyboards/lfkeyboards/lfkpad/readme.md @@ -1,28 +1,15 @@ -bluepad keyboard firmware -====================== +# LFKPad -## Quantum MK Firmware + -For the full Quantum feature list, see [the parent readme.md](/docs/README.md). +Hotswap 21-key numpad PCB with USB-C, per-key RGB and underglow. -## Building +* Keyboard Maintainer: QMK community +* Hardware Supported: LFKPad HS21 PCB +* Hardware Availability: [LFKeyboards](https://www.lfkeyboards.com/lfkpad/) -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. +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. + make lfkeyboards/lfkpad:default -### 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/` +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). |