summaryrefslogtreecommitdiff
path: root/keyboards/telophase/readme.md
diff options
context:
space:
mode:
authorAlex Ong <the.onga@gmail.com>2019-01-04 19:39:14 +1100
committerAlex Ong <the.onga@gmail.com>2019-01-04 19:39:14 +1100
commit47c91fc7f75ae0a477e55b687aa0fc30da0a283c (patch)
tree65ad39452748ff2e6d4a83ce54ede6ca22c9ada9 /keyboards/telophase/readme.md
parentac9b88e8ccbbf38762871504cd827ff0d941c426 (diff)
parent563ce3f225d981ce460c12ca5130dfe47af41df0 (diff)
downloadqmk_firmware-47c91fc7f75ae0a477e55b687aa0fc30da0a283c.tar.gz
qmk_firmware-47c91fc7f75ae0a477e55b687aa0fc30da0a283c.zip
Merge branch 'master' of https://github.com/qmk/qmk_firmware
Diffstat (limited to 'keyboards/telophase/readme.md')
-rw-r--r--keyboards/telophase/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/telophase/readme.md b/keyboards/telophase/readme.md
new file mode 100644
index 0000000000..86b29d01d6
--- /dev/null
+++ b/keyboards/telophase/readme.md
@@ -0,0 +1,16 @@
+Telophase
+=========
+
+A wireless split compact keyboard.
+
+Hardware Supported: Telophase PCB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make telophase:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+
+## Mitosis Notes
+
+These configuration files were based off the Atreus keyboard. It assumes a Pro Micro is being used, however retains the 'make upload' feature from the Atreus branch. This keyboard uses a completely different 'matrix scan' system to other keyboards, it relies on an external nRF51822 microcontroller maintaining a matrix of keystates received from the keyboard halves. The matrix.c file contains the code to poll the external microcontroller for the key matrix. As long as this file is not changed, all other QMK features are supported.