aboutsummaryrefslogtreecommitdiff
path: root/keyboards/pluckey/readme.md
diff options
context:
space:
mode:
authorfloookay <[email protected]>2021-10-16 04:01:35 +0200
committerGitHub <[email protected]>2021-10-15 19:01:35 -0700
commitb0d293a841977d393c81bef443f7e28f7764ee30 (patch)
treec6cff944c3583fca5e4a6ec9fbafe645d2140b6b /keyboards/pluckey/readme.md
parent8bb1fd04d4d4501a7bc1312e10d1fa639851fd8f (diff)
downloadqmk_firmware-b0d293a841977d393c81bef443f7e28f7764ee30.tar.gz
qmk_firmware-b0d293a841977d393c81bef443f7e28f7764ee30.zip
[Keyboard] add Pluckey (#14672)
Co-authored-by: Drashna Jaelre <[email protected]> Co-authored-by: Ryan <[email protected]>
Diffstat (limited to 'keyboards/pluckey/readme.md')
-rw-r--r--keyboards/pluckey/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/pluckey/readme.md b/keyboards/pluckey/readme.md
new file mode 100644
index 0000000000..b0a1af99b8
--- /dev/null
+++ b/keyboards/pluckey/readme.md
@@ -0,0 +1,19 @@
+# Pluckey
+
+![pluckey](https://gist.githubusercontent.com/floookay/ea7313862e407c9b5aaea3d6ed3ce233/raw/1757078b1adf7ac4d51d74f445107bdb46e013a3/sandwich%2520angle.jpg)
+
+The pluckey is an ergodox like split keyboard with moderate columnal stagger and a horizontal space key.
+
+* Keyboard Maintainer: [floookay](https://github.com/floookay)
+* Hardware Supported: pluckey pcbs with pro micro controllers
+* Hardware Availability: [pcb &amp; case files](https://github.com/floookay/pluckey)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make pluckey:default
+
+Flashing example for this keyboard:
+
+ make pluckey:default:flash
+
+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).