aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/planck/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/planck/readme.md')
-rw-r--r--keyboards/planck/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/planck/readme.md b/keyboards/planck/readme.md
new file mode 100644
index 000000000..b1a8c23b2
--- /dev/null
+++ b/keyboards/planck/readme.md
@@ -0,0 +1,16 @@
+Planck
+===
+
+![Planck](http://i.imgur.com/q2M3uEU.jpg)
+
+A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/planck/)
+
+Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)
+Hardware Supported: Planck PCB rev1, rev2, rev3, rev4, Teensy 2.0
+Hardware Availability: [OLKB.com](https://olkb.com), [Massdrop](https://www.massdrop.com/buy/planck-mechanical-keyboard?mode=guest_open)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make planck-rev4-default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. \ No newline at end of file