drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

[Keyboard] Pinky refactor (#11643)

Browse source 
* 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.
This commit is contained in:
James Young 2021-01-22 08:37:36 -08:00 • committed by GitHub
parent 3b663ee495
commit a7d79f4c00
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 568 additions and 555 deletions
Download patch file Download diff file Expand all files Collapse all files

25
keyboards/pinky/readme.md
View file

@ -1,25 +1,22 @@
Pinky
===
# Pinky
A split keyboard with 3 or 4 x7 vertically staggered keys and 4 thumb keys.
An idea is inspired from [crkbd](https://github.com/foostan/crkbd), [Lily58](https://github.com/kata0510/Lily58), [Ergo42](https://github.com/Biacco42/Ergo42) and [Helix](https://github.com/MakotoKurauchi/helix).
Keyboard Maintainer: [Masayuki Sunahara](https://github.com/tamanishi/) [@tamanishi](https://twitter.com/tamanishi)
Hardware Supported: Pinky3(3rows) or Pinky4(4rows) PCB, Pro Micro
Hardware Availability: [Pinky3 PCB & Case Data](https://github.com/tamanishi/Pinky3), [Pinky4 PCB & Case Data](https://github.com/tamanishi/Pinky4)
* Keyboard Maintainer: [Masayuki Sunahara](https://github.com/tamanishi/) [@tamanishi](https://twitter.com/tamanishi)
* Hardware Supported: [Pinky3 (3rows)](3/) or [Pinky4 (4rows)](4/) PCB, Pro Micro
* Hardware Availability: [Pinky3 PCB & Case Data](https://github.com/tamanishi/Pinky3), [Pinky4 PCB & Case Data](https://github.com/tamanishi/Pinky4)
Make example for pinky(3rows) keyboard (after setting up your build environment):
Make example for this keyboard (after setting up your build environment):
make pinky:default
or
make pinky/3:default
make pinky/3:default # for Pinky3
make pinky/4:default # for Pinky4
Make example for pinky(4rows) keyboard (after setting up your build environment):
Flashing example for this keyboard:
make pinky/4:default
make pinky/3:default:flash # for Pinky3
make pinky/4:default:flash # for Pinky4
Install example for pinky(3rows) keyboard:
make pinky:default:avrdude
To reset the board into bootloader mode, double-tap the Reset switch mounted on the PCB.
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).