diff options
| author | Luiz Ribeiro <luizribeiro@gmail.com> | 2017-07-04 11:17:28 -0400 |
|---|---|---|
| committer | Luiz Ribeiro <luizribeiro@gmail.com> | 2017-07-04 11:17:28 -0400 |
| commit | d5486265b8afcada68306c815b08c225fce287af (patch) | |
| tree | 8fb7f8fee4aa3937003bd69d5c77ca867c010d12 /keyboards/preonic/readme.md | |
| parent | 738b072bb0f25d0369a998c550c369e4f64cc7a5 (diff) | |
| parent | 34c8bf47a76c8a2dcd3b1a19dd608f8fb2fafb31 (diff) | |
| download | firmware-d5486265b8afcada68306c815b08c225fce287af.tar.gz firmware-d5486265b8afcada68306c815b08c225fce287af.tar.bz2 firmware-d5486265b8afcada68306c815b08c225fce287af.zip | |
Merge branch 'master' into ps2avrGB
Diffstat (limited to 'keyboards/preonic/readme.md')
| -rw-r--r-- | keyboards/preonic/readme.md | 31 |
1 files changed, 10 insertions, 21 deletions
diff --git a/keyboards/preonic/readme.md b/keyboards/preonic/readme.md index 10763ee97..2a4ccd84d 100644 --- a/keyboards/preonic/readme.md +++ b/keyboards/preonic/readme.md @@ -1,27 +1,16 @@ -Preonic keyboard firmware -====================== -DIY/Assembled compact ortholinear 50% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). +Preonic +=== -## Quantum MK Firmware + -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 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 a file in the keymaps folder named `<name>.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 a keymap like this: - -``` -$ make [default|jack|<name>] -``` - -Keymaps follow the format **__\<name\>.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 |