summaryrefslogtreecommitdiff
path: root/keyboards/kinesis/readme.md
diff options
context:
space:
mode:
authorJosh Colbeck2017-02-21 20:31:16 -0600
committerJosh Colbeck2017-02-21 20:31:16 -0600
commite51001efcc3ff8b64f8264e8bd4c2dbea15f3364 (patch)
treebdf5a0a4b44d5e63ba1376b70d94f64c77f3c90c /keyboards/kinesis/readme.md
parentc56693f858cb3409e4a68a8e65a1370c022a51ed (diff)
parent7ff41df32c29bca4e3a6efc3047b8fa93bb99b92 (diff)
Merge remote-tracking branch 'qmk/master'
Diffstat (limited to 'keyboards/kinesis/readme.md')
-rw-r--r--keyboards/kinesis/readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/keyboards/kinesis/readme.md b/keyboards/kinesis/readme.md
new file mode 100644
index 000000000..2813ee273
--- /dev/null
+++ b/keyboards/kinesis/readme.md
@@ -0,0 +1,12 @@
+# Firmware for the Kinesis advantage keyboard
+
+There are at least two different ways to replace the controller in this keyboard.
+
+The Stapelberg folder contains the docs and configuration for using the custom controller created by Michael Stapelberg.
+
+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
+
+