summaryrefslogtreecommitdiff
path: root/keyboards/pinky/4/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2021-01-22 08:37:36 -0800
committerGitHub <noreply@github.com>2021-01-22 08:37:36 -0800
commita7d79f4c0060125a29cb0b3a9f8d9ad8356344c6 (patch)
tree60c74bbb101feae7316204454cba063d1ac7b97e /keyboards/pinky/4/readme.md
parent3b663ee4950bc550cba3f6faca7dee5be34bf956 (diff)
[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.
Diffstat (limited to 'keyboards/pinky/4/readme.md')
-rw-r--r--keyboards/pinky/4/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/pinky/4/readme.md b/keyboards/pinky/4/readme.md
new file mode 100644
index 0000000000..8209a02e0c
--- /dev/null
+++ b/keyboards/pinky/4/readme.md
@@ -0,0 +1,20 @@
+# Pinky4
+
+A split keyboard with 4x7 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: Pinky4 (4rows) PCB, Pro Micro
+* Hardware Availability: [Pinky4 PCB & Case Data](https://github.com/tamanishi/Pinky4)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make pinky/4:default
+
+Flashing example for this keyboard:
+
+ make pinky/4:default:flash
+
+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).