drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

kinesis remap

Browse source
This commit is contained in:
milestogo 2017-01-08 22:02:01 -08:00
parent 176b93d08e
commit f74ff86f9c
45 changed files with 2006 additions and 267 deletions
Download patch file Download diff file Expand all files Collapse all files

44
keyboards/kinesis/readme.md
View file

@ -1,42 +1,12 @@
kinesis-advantage keyboard firmware
======================
# Firmware for the Kinesis advantage keyboard
## 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
There are at least two different ways to replace the controller in this keyboard.
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.
The Stapelberg folder contains the docs and configuration for using the custom controller created by Michael Stapelberg.
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
The alvicstep folder contains docs and configuration for directly wiring a Teensy2++ to the existing controller board. This follows the pinouts described in https://github.com/alvicstep/tmk_keyboard, which is where the name comes from.
## Keymaps
Both hardware solutions should work with the same keymaps
## 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/`