qmk-firmware/keyboard/atomic/README.md

Atomic keyboard firmware
======================
DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).

## Quantum MK Firmware

For the full Quantum feature list, see [the parent README.md](/README.md).

## Building

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 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:
```
$ make KEYMAP=[default|jack|<name>]
```
Keymaps follow the format **__keymap\_\<name\>.c__** and are stored in the `keymaps` folder.
preonic 2015-08-21 16:46:53 +02:00			`Atomic keyboard firmware`
atomic 2015-08-16 23:56:56 +02:00			`======================`
preonic 2015-08-21 16:46:53 +02:00			`DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).`
atomic 2015-08-16 23:56:56 +02:00
atomic up-to-date 2015-10-30 05:48:17 +01:00			`## Quantum MK Firmware`
atomic 2015-08-16 23:56:56 +02:00
README changes 2016-02-07 16:41:00 +01:00			`For the full Quantum feature list, see [the parent README.md](/README.md).`
atomic up-to-date 2015-10-30 05:48:17 +01:00
			`## Building`

readme 2015-10-30 05:49:47 +01: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.
atomic up-to-date 2015-10-30 05:48:17 +01: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:
atomic 2015-08-16 23:56:56 +02:00			```
atomic up-to-date 2015-10-30 05:48:17 +01:00			`$ make KEYMAP=[default\|jack\|<name>]`
atomic 2015-08-16 23:56:56 +02:00			```
atomic up-to-date 2015-10-30 05:48:17 +01:00			Keymaps follow the format __keymap\_\<name\>.c__ and are stored in the `keymaps` folder.