keyboards/kinesis/alvicstep/readme.md

   1 kinesis-advantage keyboard firmware
   2 ======================
   3
   4 This directory is called alvicstep because https://github.com/alvicstep did the heavy work and took the photos in the doc directory.
   5 alvicstep did NOT do anything related to the QMK implementation, so don't bug him/her.
   6
   7 There are other ways of replacing the CPU in the kinesis, this one uses jumper wires from the Teensy to the original DIP socket
   8
   9
  10 ## Kinesis specific information
  11 This is a port of https://github.com/alvicstep/tmk_keyboard,
  12 which is a fork of https://github.com/wjanssens/tmk_keyboard,
  13 which is based on work from https://github.com/chrisandreae/keyboard-firmware
  14
  15 If you replace the kinesis CPU as described in the doc folder, then this code should allow you to use QMK.
  16 I've tested with a Teensy 2++, remember to change the CPU if you use a 32u4 instead.
  17
  18 Not yet implemented:
  19 - Kinesis EEProm reading or writing
  20 - Audio - this should be simple if we remove hardcoded pins from audio.h and switch to E7
  21
  22
  23
  24 ## Quantum MK Firmware
  25
  26 For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
  27
  28 ## Building
  29
  30 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.
  31
  32 Depending on which keymap you would like to use, you will have to compile slightly differently.
  33
  34 ### Default
  35
  36 To build with the default keymap, simply run `make`.
  37
  38 ### Other Keymaps
  39
  40 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.
  41
  42 To build the firmware binary hex file with a keymap just do `make` with `keymap` option like:
  43
  44 $ make keymap=[default|jack|<name>]
  45
  46 Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`