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/preonic | |
| parent | 169ede07155764deb6a559f0438b1b7fa7138bef (diff) | |
updates olkb readmes #1362
Diffstat (limited to 'keyboards/preonic')
| -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 10763ee97a..2a4ccd84dc 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 |