2015-10-27 19:33:18 +01:00
%KEYBOARD% keyboard firmware
======================
## Quantum MK Firmware
Makefile redo & other features (#395)
* .build containment implemented
* no destructive variable setting - builds in either folder
* make from 3 places
* cleans before each build
* make from root with keyboard=keyboard, keymap=keymap
* make from keyboard/keyboard with keymap=keymap
* make from keymaps/keymap
* only implemented on planck
* adds color diag to avr-gcc
* makefiles for all plancks, clean-up
* quick build-all makefile for plancks
* reformatting of make output (colors)
* color toggle, tmk path corrections
* correct if statement for color
* move config.h to main makefile, updates preonic, atomic
* format update, all keyboards targets
* makefile optional for build all target, alps and arrow_pad updated
* alps updated
* make planck default, trying out travis recipe for all-keyboards
* all-keymaps target, different travis recipe
* updates alps64
* updates keyboards to new format
* updates clue* projects
* all projects updated, specialise EZ .hex, let .hex through
* updates travis
* automatically find root, keyboard, keymap
* silent echo, cleaned-up mass make output
* updates all keyboards' .hex files except EZ
* Rename Bantam44.c to bantam44.c
* Rename Bantam44.h to bantam44.h
* nananana
* adds six key keyboard
* does same to ez as rest
* updates send_string example
* brings ergodox_ez up to date
* updates template/new project script
* adds sixkeyboard
* adds readme for sixkeyboard
* adds sixkeyboard to travis
* filenames, gitignore mess
* define clock prescaler stuff manually
* make quick, size test example
* documentation and dfu-no-build
2016-06-11 19:31:31 +02:00
For the full Quantum feature list, see [the parent README.md ](/doc/README.md ).
2015-10-30 05:48:17 +01:00
## Building
2016-02-07 16:41:00 +01:00
Download or clone the whole firmware and navigate to the keyboard/%KEYBOARD% folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file.
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` .
2015-10-27 19:33:18 +01:00
2015-10-30 05:48:17 +01:00
### Other Keymaps
2016-03-30 03:53:36 +02: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 file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top README.md) and existent keymap files.
2015-10-27 19:33:18 +01:00
2015-10-30 05:48:17 +01:00
To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
2015-10-27 19:33:18 +01:00
```
$ make KEYMAP=[default|jack|< name > ]
```
2016-01-24 02:45:52 +01:00
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
