]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/planck/readme.md
[Keyboard] Planck Layout Macro Refactor, Part II (#6156)
[qmk_firmware.git] / keyboards / planck / readme.md
1 Planck
2 ===
3
4 ![Planck](http://i.imgur.com/q2M3uEU.jpg)
5
6 A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/planck/)
7
8 Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)  
9 Hardware Supported: Planck PCB rev1, rev2, rev3, rev4, rev5, rev6; Planck Light, Planck EZ  
10 Hardware Availability: [OLKB.com](https://olkb.com), [Massdrop](https://www.massdrop.com/buy/planck-mechanical-keyboard?mode=guest_open)
11
12 Make example for this keyboard (after setting up your build environment):
13
14     make planck/rev4:default
15
16 Install examples:
17
18     make planck/rev5:default:dfu         # For Planck rev5 or earlier and Planck Light
19     make planck/rev6:default:dfu-util    # For Planck rev6
20
21 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).