diff options
author | Toni <jeder@mail1a.de> | 2016-07-25 12:49:38 +0200 |
---|---|---|
committer | Toni <jeder@mail1a.de> | 2016-07-25 12:49:38 +0200 |
commit | 5e2e8c89e86fbabb65737789ff0545e3e8ac1610 (patch) | |
tree | ce13a00ccc10fdc147a0e8caa0c2a1bbabfda357 /keyboards/kinesis/readme.md | |
parent | 5631f1436c356fb9e09138f186981dc9b6cb43a2 (diff) | |
parent | 8b94e26d7c3b30cc57d710a11e5651d15e8e3b20 (diff) |
Merge remote-tracking branch 'origin/master' into iso_split_rshift
whatever
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 0000000000..a990f9cb99 --- /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`. + +### 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 `keymap` option like: + +``` +$ make keymap=[default|jack|<name>] +``` + +Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` |