diff options
author | Jack Humbert <jack.humb@gmail.com> | 2016-06-11 13:31:31 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-06-11 13:31:31 -0400 |
commit | d9e4dad0a828a8a904f44dda090a4d6d08fe2948 (patch) | |
tree | d6f002712c22e8cf4523e04a9da889c7ec379d6b /keyboard/kc60/README.md | |
parent | a5d638ad3091e2d553eaa04d933df28eeced5a8b (diff) | |
download | firmware-d9e4dad0a828a8a904f44dda090a4d6d08fe2948.tar.gz firmware-d9e4dad0a828a8a904f44dda090a4d6d08fe2948.tar.bz2 firmware-d9e4dad0a828a8a904f44dda090a4d6d08fe2948.zip |
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
Diffstat (limited to 'keyboard/kc60/README.md')
-rw-r--r-- | keyboard/kc60/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboard/kc60/README.md b/keyboard/kc60/README.md new file mode 100644 index 000000000..4be448d15 --- /dev/null +++ b/keyboard/kc60/README.md @@ -0,0 +1,24 @@ +kc60 keyboard firmware +====================== + +## 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/kc60 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. + +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 `<name>.c` in the keymaps folder, 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. |