qmk_firmware/keyboards/preonic/readme.md

26 lines
1.2 KiB
Markdown
Raw Normal View History

2016-03-30 04:46:45 +00:00
Preonic keyboard firmware
2015-08-21 14:46:53 +00:00
======================
2016-03-30 04:46:45 +00:00
DIY/Assembled compact ortholinear 50% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
2015-08-21 14:46:53 +00:00
2016-03-30 04:43:07 +00:00
## Quantum MK Firmware
2015-08-21 14:46:53 +00:00
For the full Quantum feature list, see [the parent readme.md](/readme.md).
2015-08-21 14:46:53 +00:00
2016-03-30 04:43:07 +00:00
## Building
2015-08-21 14:46:53 +00:00
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.
2015-08-21 14:46:53 +00:00
Depending on which keymap you would like to use, you will have to compile slightly differently.
2016-03-30 04:43:07 +00:00
### Default
To build with the default keymap, simply run `make`.
2015-08-21 14:46:53 +00:00
2016-03-30 04:43:07 +00:00
### 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.
2015-08-21 14:46:53 +00:00
2016-03-30 04:43:07 +00:00
To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
2015-08-21 14:46:53 +00:00
```
2016-03-30 04:43:07 +00:00
$ make KEYMAP=[default|jack|<name>]
2015-08-21 14:46:53 +00:00
```
2016-03-30 13:17:06 +00:00
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.