History

Jack Humbert 287eb7ad14 Converted audio play functions to _user (#349 ) Updated personal layouts * tweaked personal * Nightly - Audio Cleanup Refactored the LUTs. Abstracted some of the registers out of audio to use more functional names. Split audio into audio and audio_pwm. WIP * nightly - collapsed code * Added check for note playing to LEDs * Usability tweaks * TWEAE * nightly added extra kcs to keymap common * turned on Plank audio * Added backlight breathing to atomic * reverted accidental merge * Added music and audio toggles to Quantum.c * Redid the audio callbacks * Adjusted default planck layout to use the user tone naming * tabs to spaces * Rewrote the ALL recipe to allow for faster parallel make * tabs to spaces * Renamed custom event functions to be 'startup_user' and 'shutdown_user'. Also moved the prototypes around. * Tweaked pvc atomic layout to work with the pvc planck. * updates midi scale calling		2016-05-24 11:56:53 -04:00
..
keymaps	Converted audio play functions to *_user (#349 )	2016-05-24 11:56:53 -04:00
Makefile	moves backlight functionality to keyboard files and updates template makefile	2016-04-29 22:19:40 -04:00
README.md	Updated several keyboard folders to use new keymap naming scheme	2016-03-29 21:53:36 -04:00
atomic.c	Leader key implementation (#326 )	2016-05-15 00:27:32 -04:00
atomic.h	cleans up default keymaps (olkb)	2016-05-15 01:07:48 -04:00
atomic_pcb.hex	atomic hex	2015-11-21 15:01:33 -05:00
config.h	Optimize matrix scanning (#343 )	2016-05-23 23:42:21 -04:00
flash-pcb.sh	bluetooth	2015-10-22 13:37:45 -04:00

README.md

Atomic keyboard firmware

DIY/Assembled ortholinear 60% keyboard by Ortholinear Keyboards.

Quantum MK Firmware

For the full Quantum feature list, see the parent 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 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.