diff options
| author | zvecr <z.zvecr@gmail.com> | 2018-11-08 23:17:41 +0000 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2018-11-08 15:17:41 -0800 |
| commit | 73883425a55f23a319eb1522c2e3ce52b8e2f042 (patch) | |
| tree | 83ba7208aeabd10d8d0cf36f573ae7b25ef79713 /keyboards/40percentclub/5x5/readme.md | |
| parent | ef84bd979979f092980dc68d513a906e084c8c57 (diff) | |
relocate 40percent.club boards to new parent folder (#4380)
* Initial move of 40percent.club boards to common parent folder.
* Refactor readme files to be consistent
* Refactor readme files to be consistent - fix make command examples.
* Refactor readme files to be consistent - align readme filenames.
* Refactor readme files to be consistent - fix repo url.
* Disable Community keymap builds as they are currently failing due to missing functionality
* Move more of 40percent.club boards to common parent folder.
* Refactor readme files to be consistent - align readme filenames.
* Refactor readme files to be consistent - fix make command examples.
Diffstat (limited to 'keyboards/40percentclub/5x5/readme.md')
| -rw-r--r-- | keyboards/40percentclub/5x5/readme.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/40percentclub/5x5/readme.md b/keyboards/40percentclub/5x5/readme.md new file mode 100644 index 0000000000..8f0d8e1667 --- /dev/null +++ b/keyboards/40percentclub/5x5/readme.md @@ -0,0 +1,24 @@ +# 5x5 + + +=== + +**Modular Keypad/Keyboard** +The basic unit is a 5x5 matrix with 25 keys. Up to 3 of these can be connected to each other side by side. +5x5, 5x10, and 5x15 matrices 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/5x5) + +Keyboard Maintainer: QMK Community +Hardware Supported: 5x5 PCB +Hardware Availability: [5x5 project on 40% Keyboards](http://www.40percent.club/2018/04/5x5.html) + +Make example for this keyboard (after setting up your build environment): + + make 40percentclub/5x5:default + +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). + +First pass at adding support for the 4x4 keyboard. Compiles but completely untested. Intended to kick-start development. |