summaryrefslogtreecommitdiff
path: root/keyboards/planck/rev1/readme.md
diff options
context:
space:
mode:
authornoroadsleft <18669334+noroadsleft@users.noreply.github.com>2019-06-19 10:56:20 -0700
committerDrashna Jaelre <drashna@live.com>2019-06-19 10:56:20 -0700
commit5f0ab5a24b4ec9ea01a5fd95bda9315ac6e96142 (patch)
tree5b4dc4f2dfa1b41a1a8abf7e4ef20c0dbdcd71cb /keyboards/planck/rev1/readme.md
parenta825bbf5eac56ed7358d71d952ba4d795bc1b1ef (diff)
[Keyboard] Planck Layout Macro Refactor, Part II (#6156)
* Move layout macros to revision folders * Update Planck EZ layout macros Planck EZ only supports one layout (centered 2u spacebar). Deleted all the other macros. * Flesh out QMK Configurator support Give each Planck revision its own info.json file. * Readme updates - give each revision its own readme - add the Planck EZ to the main Planck readme * Fix layout macro for Planck EZ Previous matrix didn't compile because the electrical matrix defined a k3b location, which was unused by the physical arguments. Drashna was kind enough to confirm the Planck EZ's matrix for me. Co-authored-by: Drashna Jaelre <drashna@live.com> * Pretend the Planck EZ supports ortho_4x12 layout The hardware doesn't, but doing so prevents CI errors because the default keymap uses LAYOUT_planck_grid. Going to pretend LAYOUT_ortho_4x12 is a valid layout for the Planck EZ. * Update Planck EZ's URL in info.json Co-Authored-By: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/planck/rev1/readme.md')
-rw-r--r--keyboards/planck/rev1/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/planck/rev1/readme.md b/keyboards/planck/rev1/readme.md
new file mode 100644
index 0000000000..b5561fc1a7
--- /dev/null
+++ b/keyboards/planck/rev1/readme.md
@@ -0,0 +1,13 @@
+# Planck
+
+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
+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/rev1:default
+
+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).