qmk_firmware/keyboard/atomic/README.md

26 lines
1.2 KiB
Markdown
Raw Normal View History

2015-08-21 14:46:53 +00:00
Atomic keyboard firmware
2015-08-16 21:56:56 +00:00
======================
2015-08-21 14:46:53 +00:00
DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
2015-08-16 21:56:56 +00:00
2015-10-30 04:48:17 +00:00
## Quantum MK Firmware
2015-08-16 21:56:56 +00:00
2016-02-07 15:41:00 +00:00
For the full Quantum feature list, see [the parent README.md](/README.md).
2015-10-30 04:48:17 +00:00
## Building
2015-10-30 04:49:47 +00:00
Download or clone the whole firmware and navigate to the keyboard/atomic 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-10-30 04:48:17 +00:00
Depending on which keymap you would like to use, you will have to compile slightly differently.
### 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 file named `keymap_<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 `KEYMAP` option like:
2015-08-16 21:56:56 +00:00
```
2015-10-30 04:48:17 +00:00
$ make KEYMAP=[default|jack|<name>]
2015-08-16 21:56:56 +00:00
```
2015-10-30 04:48:17 +00:00
Keymaps follow the format **__keymap\_\<name\>.c__** and are stored in the `keymaps` folder.