gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2024-12-22 01:23:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
97910fac06
qmk_firmware/keyboards/pinky/readme.md
James Young a7d79f4c00
[Keyboard] Pinky refactor (#11643) 
* QMK Configurator layout support for Pinky

3-row and 4-row versions

* refactor default keymaps

- use an enum for layer names
- remove redundant definitions
- qmk cformat pass
- modify pinky/4 via keymap to mirror pinky/4 default functionality

* remove LAYOUT_kc macros

This usage is not endorsed by QMK as it has been found to be confusing to novice users.

* add VIA support to pinky/3

* update config.h files

Removes unnecessary definitions for Backlight, RGB Underglow, Magic config and MIDI.

* update main rules.mk file

Updates the rules.mk file to match the formatting of the current QMK-provided template. Removes sample bootloader comments, feature rules that are no longer included in the template, and updates the in-line comments.

* update and split keyboard readme

Updates the main readme file's formatting, adds instructions to access bootloader mode, and adds more specific readmes for each version.

* add line breaks between rows in the info.json files

* rename layout macros for Community Layout forward compatibility

The layouts of the Pinky3 and Pinky4 aren't currently Community Layouts, but support for them could be added with a rules.mk edit should the layouts be added to QMK.
2021-01-22 08:37:36 -08:00

1.3 KiB
Raw Blame History

Pinky

A split keyboard with 3 or 4 x7 vertically staggered keys and 4 thumb keys. An idea is inspired from crkbd, Lily58, Ergo42 and Helix.

Make example for this keyboard (after setting up your build environment):

make pinky/3:default  # for Pinky3
make pinky/4:default  # for Pinky4

Flashing example for this keyboard:

make pinky/3:default:flash  # for Pinky3
make pinky/4:default:flash  # for Pinky4

To reset the board into bootloader mode, double-tap the Reset switch mounted on the PCB.

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.