summaryrefslogtreecommitdiffstats
path: root/keyboards/4x4/readme.md
diff options
context:
space:
mode:
authorwanleg <32079073+wanleg@users.noreply.github.com>2018-08-02 22:48:39 +0200
committerDrashna Jaelre <drashna@live.com>2018-08-02 22:48:39 +0200
commit62a86031223fcbfbed437493c69b27493c52206d (patch)
treea438f6dd1a8660f2814d9e890340c8d2c5b878a2 /keyboards/4x4/readme.md
parent6c20c6219cfcb061235d4bee2b8e0641b0026162 (diff)
downloadqmk_firmware-62a86031223fcbfbed437493c69b27493c52206d.tar.gz
qmk_firmware-62a86031223fcbfbed437493c69b27493c52206d.tar.xz
Keyboard: 4x4 modular keyboard (#3531)
* add support for 4x4 macropad * Update readme.md * set DFU escape key * cleanup * Update config.h * Update keymap.c * Update config.h * Update keymap.c * Update 4x4.h * reviewed fudging review automation * playing with the system * reverting * Required additions made Added support for additional layouts * tidy up default keymap
Diffstat (limited to 'keyboards/4x4/readme.md')
-rw-r--r--keyboards/4x4/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/4x4/readme.md b/keyboards/4x4/readme.md
new file mode 100644
index 000000000..3ca074fdd
--- /dev/null
+++ b/keyboards/4x4/readme.md
@@ -0,0 +1,23 @@
+# 4x4
+
+![4x4](https://2.bp.blogspot.com/-xRZOpwlTT4c/WlOwRIVAecI/AAAAAAACKo4/d75juHTX2W0Nrch7NigssMbagvl3I4w_ACEwYBhgL/s1600/e.jpg)
+===
+
+**Modular keypad/keyboard**
+The basic unit is a 4x4 matrix with 16 keys. Up to 4 of these can be connected to each other side by side.
+4x4, 4x8, 4x12 and 4x16 are possible.
+There are pads for header pins on each side that complete the circuits from board to board. These can be permanently connected with solder bridges or temporarily with pin headers and shunt jumpers.
+**_All configurations are powered by a SINGLE Arduino Micro or clone (NOT a Pro Micro)._**
+
+* [The original TMK firmware](https://github.com/di0ib/tmk_keyboard/tree/master/keyboard/4x4)
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: 4x4 PCB
+Hardware Availability: [4x4x4x4x4 project on 40% Keyboards](http://www.40percent.club/2018/01/4x4x4x4x4.html)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make 4x4: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.
+First pass at adding support for the 4x4 keyboard. Compiles but completely untested. Intended to kick-start development.