sporq/qmk-firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Keyboard] LFKPad refactor (#8079)

Browse Source
This commit is contained in:
fauxpark
2020-02-05 13:41:19 +11:00
committed by GitHub
parent 74e3cad728
commit efe8bd8e92
9 changed files with 241 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
keyboards/lfkeyboards/lfkpad/readme.md
View File

@@ -1,28 +1,15 @@
bluepad keyboard firmware
======================
# LFKPad
## Quantum MK Firmware
![LFKPad](https://cdn11.bigcommerce.com/s-dvx2zpcx7r/images/stencil/500x659/products/118/385/img_0256__06462.1546304848.jpg)
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).