diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-06-25 12:40:25 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-06-25 12:40:25 -0400 |
| commit | 1a4a66fd015990942a7248160aa63eb2fa6e59af (patch) | |
| tree | c20b700a97d9bae401bda82c7be2333a9be0c8eb /keyboards/planck | |
| parent | 169ede07155764deb6a559f0438b1b7fa7138bef (diff) | |
updates olkb readmes #1362
Diffstat (limited to 'keyboards/planck')
| -rw-r--r-- | keyboards/planck/readme.md | 37 |
1 files changed, 10 insertions, 27 deletions
diff --git a/keyboards/planck/readme.md b/keyboards/planck/readme.md index 4b24a690e0..b1a8c23b2e 100644 --- a/keyboards/planck/readme.md +++ b/keyboards/planck/readme.md @@ -1,33 +1,16 @@ -Planck keyboard firmware -====================== -DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). +Planck +=== -## Quantum MK Firmware + -For the full Quantum feature list, see [the parent readme.md](/readme.md). +A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/planck/) -## Building +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) -Download or clone the whole firmware and navigate to the keyboards/planck folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button. +Make example for this keyboard (after setting up your build environment): -Depending on which keymap you would like to use, you will have to compile slightly differently. + make planck-rev4-default -### Default -To build with the default keymap, simply run `make default`. - -### Other Keymaps -Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top readme.md) and existent keymap files. - -To build the firmware binary hex file with a keymap just do `make` with a keymap like this: - -``` -$ make [default|jack|<name>] -``` - -Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. - -### Notable forks (which some of the keymap files are from) -- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck) -- [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c) -- [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck) -- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid) +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 |