aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/nek_type_a/readme.md
diff options
context:
space:
mode:
authorMike Roberts <miker@miker.org>2019-05-11 21:12:06 -0400
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-05-11 18:12:06 -0700
commitf542c0589bec06501a3990070c08638a9124f055 (patch)
tree82fa658c9b6a16bde2f8b3a91239c085af09763a /keyboards/nek_type_a/readme.md
parentd53cbd2dc6ec6877f2815c546c03b39fac7a8afa (diff)
downloadfirmware-f542c0589bec06501a3990070c08638a9124f055.tar.gz
firmware-f542c0589bec06501a3990070c08638a9124f055.tar.bz2
firmware-f542c0589bec06501a3990070c08638a9124f055.zip
NEK Type A (#5175)
* project creation and config.h import * fix name * cleanup * layout for left * working left with feather pins * full keymap * ? * let's do this * non working twimaster version * it fucking works! * bluetooth! * cleanup * use auto output for ADAFRUIT_BLE * remove auto from custom matrix * better ble auto * fix f1 * revert * fix ble * update readme * Update readme.md * Update readme.md
Diffstat (limited to 'keyboards/nek_type_a/readme.md')
-rw-r--r--keyboards/nek_type_a/readme.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/nek_type_a/readme.md b/keyboards/nek_type_a/readme.md
new file mode 100644
index 000000000..49f4a4659
--- /dev/null
+++ b/keyboards/nek_type_a/readme.md
@@ -0,0 +1,30 @@
+# nek_type_a
+
+![NEK Type A Keyboard](https://i.imgur.com/XFnjlQ9.jpg)
+
+Natural Ergonomic Keyboard, Type A
+
+Keyboard Maintainer: [Mike Roberts](https://github.com/ecopoesis)
+Hardware Supported: Custom PCBs from https://github.com/ecopoesis/nek-type-a
+Hardware Availability: https://github.com/ecopoesis/nek-type-a
+
+## Design
+
+This is a column-driven split keyboard using three custom PCBs connected with ribbon cables. The left and right PCBs are
+passive: they only have the diodes and switches needed to make the matrix. The center PCB has an Adafruit Feather 32u4 and
+MCP23017 expander.
+
+The left matrix has its rows and columns directly connected to the Feather. The right matrix has its rows connect to the
+Feather (using the same pins as the left matrix) and its columns connected to the expander. The expander uses the LUFA
+hardware TWI driver.
+
+Bluetooth is enabled.
+
+## Building
+
+Make and install this keyboard (after setting up your build environment):
+```
+make nek_type_a:default:avrdude
+```
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).