diff options
author | Stanley Lai <stanleylai.sg@gmail.com> | 2016-12-17 13:49:13 -0800 |
---|---|---|
committer | Stanley Lai <stanleylai.sg@gmail.com> | 2016-12-17 13:49:13 -0800 |
commit | b49d7800aeae1009b39b2bff2121864425e73ce9 (patch) | |
tree | f73447fc32940c7bc6b691a83567186d1afbc991 /keyboards/kinesis/readme.md | |
parent | 9ecf9073b96799e52a1f1c0d35b57177382902ce (diff) | |
parent | ae95834f5af7404c04e6fe3446019046278d814b (diff) | |
download | firmware-b49d7800aeae1009b39b2bff2121864425e73ce9.tar.gz firmware-b49d7800aeae1009b39b2bff2121864425e73ce9.tar.bz2 firmware-b49d7800aeae1009b39b2bff2121864425e73ce9.zip |
Merge remote-tracking branch 'refs/remotes/jackhumbert/master'
Diffstat (limited to 'keyboards/kinesis/readme.md')
-rw-r--r-- | keyboards/kinesis/readme.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/keyboards/kinesis/readme.md b/keyboards/kinesis/readme.md new file mode 100644 index 000000000..79c86581e --- /dev/null +++ b/keyboards/kinesis/readme.md @@ -0,0 +1,42 @@ +kinesis-advantage keyboard firmware +====================== + +## Kinesis specific information +This is a port of https://github.com/alvicstep/tmk_keyboard, +which is a fork of https://github.com/wjanssens/tmk_keyboard, +which is based on work from https://github.com/chrisandreae/keyboard-firmware + +If you replace the kinesis CPU as described in the doc folder, then this code should allow you to use QMK. +I've tested with a Teensy 2++, remember to change the CPU if you use a 32u4 instead. + +Not yet implemented: +- Kinesis EEProm reading or writing +- Audio - this should be simple if we remove hardcoded pins from audio.h and switch to E7 + + + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). + +## Building + +Download or clone the whole firmware and navigate to the keyboards/kinesis-advantage 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 default`. + +### 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 folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files. + +To build the firmware binary hex file with a keymap just do `make` with a keymap like this: + +``` +$ make [default|jack|<name>] +``` + +Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` |