summaryrefslogtreecommitdiff
path: root/keyboards/pinky/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/pinky/readme.md')
-rw-r--r--keyboards/pinky/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/pinky/readme.md b/keyboards/pinky/readme.md
new file mode 100644
index 0000000000..f9eb6ee2b8
--- /dev/null
+++ b/keyboards/pinky/readme.md
@@ -0,0 +1,25 @@
+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)
+
+Make example for pinky(3rows) keyboard (after setting up your build environment):
+
+ make pinky:default
+ or
+ make pinky/3:default
+
+Make example for pinky(4rows) keyboard (after setting up your build environment):
+
+ make pinky/4:default
+
+Install example for pinky(3rows) keyboard:
+
+ make pinky:default:avrdude
+
+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).