You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qmk_firmware/keyboard/atomic/README.md

26 lines
1.2 KiB
Markdown

9 years ago
Atomic keyboard firmware
9 years ago
======================
9 years ago
DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
9 years ago
## Quantum MK Firmware
9 years ago
9 years ago
For the full Quantum feature list, see [the parent README.md](/README.md).
## Building
9 years ago
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.
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 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 `KEYMAP` option like:
9 years ago
```
$ make KEYMAP=[default|jack|<name>]
9 years ago
```
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.