summaryrefslogtreecommitdiff
path: root/keyboards/pinky/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-01-22 16:38:26 +0000
committerQMK Bot <hello@qmk.fm>2021-01-22 16:38:26 +0000
commit1c3ec3a91fa61ab39e0361e87314ca12187f1ba5 (patch)
treefb56e8c742e1ab8f9021ed89b56dfb6696596850 /keyboards/pinky/readme.md
parent20ef2aa57fb09afea020b83bebd0632043eb6e34 (diff)
parenta7d79f4c0060125a29cb0b3a9f8d9ad8356344c6 (diff)
downloadqmk_firmware-1c3ec3a91fa61ab39e0361e87314ca12187f1ba5.tar.gz
qmk_firmware-1c3ec3a91fa61ab39e0361e87314ca12187f1ba5.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/pinky/readme.md')
-rw-r--r--keyboards/pinky/readme.md25
1 files changed, 11 insertions, 14 deletions
diff --git a/keyboards/pinky/readme.md b/keyboards/pinky/readme.md
index f9eb6ee2b8..0e2f1482f8 100644
--- a/keyboards/pinky/readme.md
+++ b/keyboards/pinky/readme.md
@@ -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).