opensteno_qmk/keyboards/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 keyboards/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:
```
$ make KEYMAP=[default|jack|<name>]
```
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
preonic 2015-08-21 14:46:53 +00:00			`Atomic keyboard firmware`
atomic 2015-08-16 21:56:56 +00:00			`======================`
preonic 2015-08-21 14:46:53 +00:00			`DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).`
atomic 2015-08-16 21:56:56 +00:00
atomic up-to-date 2015-10-30 04:48:17 +00:00			`## Quantum MK Firmware`
atomic 2015-08-16 21:56:56 +00:00
Backlight abstraction and other changes (#439) * redoes matrix pins, abstracts backlight code for B5,6,7 * slimming down keyboard stuff, backlight breathing implemented * don't call backlight init when no pin * cleans up user/kb/quantum calls, keyboard files * fix pvc atomic * replaces CHANNEL with correct var in breathing * removes .hexs, updates readmes, updates template * cleans-up clueboards, readmes to lowercase * updates readme 2016-06-24 02:18:20 +00:00			`For the full Quantum feature list, see [the parent readme.md](/readme.md).`
atomic up-to-date 2015-10-30 04:48:17 +00:00
			`## Building`

Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432) * fixes from tmk's repo * rename keyboard to keyboards 2016-06-22 02:39:54 +00:00			Download or clone the whole firmware and navigate to the keyboards/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 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`
Backlight abstraction and other changes (#439) * redoes matrix pins, abstracts backlight code for B5,6,7 * slimming down keyboard stuff, backlight breathing implemented * don't call backlight init when no pin * cleans up user/kb/quantum calls, keyboard files * fix pvc atomic * replaces CHANNEL with correct var in breathing * removes .hexs, updates readmes, updates template * cleans-up clueboards, readmes to lowercase * updates readme 2016-06-24 02:18:20 +00:00			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.
atomic up-to-date 2015-10-30 04:48:17 +00:00
			To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
atomic 2015-08-16 21:56:56 +00:00			```
atomic up-to-date 2015-10-30 04:48:17 +00:00			`$ make KEYMAP=[default\|jack\|<name>]`
atomic 2015-08-16 21:56:56 +00:00			```
Updated several keyboard folders to use new keymap naming scheme 2016-03-30 01:53:36 +00:00			Keymaps follow the format __\<name\>.c__ and are stored in the `keymaps` folder.