X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=keyboards%2Fpreonic%2Freadme.md;h=e116021fdd4ec413b66371432c99927d313f7306;hb=074b78700a5ebf93c5b430bc86c4c4589e1472d8;hp=f0be255a0952ce08610358115d70cf428d276184;hpb=23617779b44a4be83a055e01eaced184d5cc1a73;p=qmk_firmware.git diff --git a/keyboards/preonic/readme.md b/keyboards/preonic/readme.md index f0be255a0..e116021fd 100644 --- a/keyboards/preonic/readme.md +++ b/keyboards/preonic/readme.md @@ -1,25 +1,16 @@ -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, Teensy 2.0 +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:default -### Default -To build with the default keymap, simply run `make`. - -### 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. - -To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like: -``` -$ make KEYMAP=[default|jack|] -``` -Keymaps follow the format **__\.c__** and are stored in the `keymaps` folder. +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