X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=keyboards%2Fpreonic%2Freadme.md;h=85adf635d746a743a7560f185f69e9a6f4e1c275;hb=6af77551c67c846b06c596cbd367d66c755f8051;hp=10763ee97a406bf61082ca80ce70f342c552c4b4;hpb=8f2af3c6bcd0e300483cb72bfe2816701a0e528d;p=qmk_firmware.git diff --git a/keyboards/preonic/readme.md b/keyboards/preonic/readme.md index 10763ee97..85adf635d 100644 --- a/keyboards/preonic/readme.md +++ b/keyboards/preonic/readme.md @@ -1,27 +1,21 @@ -Preonic keyboard firmware -====================== -DIY/Assembled compact ortholinear 50% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). +Preonic +=== -## Quantum MK Firmware +![Preonic](http://i.imgur.com/EDWQbB0.jpg) -For the full Quantum feature list, see [the parent readme.md](/readme.md). +A compact 50% (12x5) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/preonic/) -## Building +Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert) +Hardware Supported: Preonic PCB rev1, rev2, rev3 +Hardware Availability: [OLKB.com](https://olkb.com/preonic/), [Massdrop](https://www.massdrop.com/buy/preonic-mechanical-keyboard?mode=guest_open) -Download or clone the whole firmware and navigate to the keyboards/preonic 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 preonic/rev2:default -### Default -To build with the default keymap, simply run `make default`. +Install examples: -### 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 a file in the keymaps folder named `.c` and see keymap document (you can find in top readme.md) and existent keymap files. + make preonic/rev2:default:dfu # For Preonic rev1 or rev2 + make preonic/rev3:default:dfu-util # For Preonic rev3 -To build the firmware binary hex file with a keymap just do `make` with a keymap like this: - -``` -$ make [default|jack|] -``` - -Keymaps follow the format **__\.c__** and are stored in the `keymaps` folder. +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).