summaryrefslogtreecommitdiff
path: root/keyboards/dumbpad/readme.md
diff options
context:
space:
mode:
authorimchipwood <charles.p.wood@intel.com>2021-03-04 20:25:19 -0800
committerGitHub <noreply@github.com>2021-03-04 20:25:19 -0800
commitd7aa245c3343542381ae0e9eb1b77eadca74da57 (patch)
tree30bd44fcc70dc7e2c49ab23adeac81b903cc7121 /keyboards/dumbpad/readme.md
parent2cb0b41ce7e9e9bc743451d7412a3114ec1d01b2 (diff)
dumbpad refactor - adding support for various PCB revisions (#9259)
* Placeholder commit - Refactored to support different PCB revisions Individual revision folders still need: - info.json - readme.md all v0x folders support up to two LEDs for layer indication all v1x folders support up to two LEDs for layer indication plus one extra LED for numlock indication v0x - supports single-encoder v0.x PCB revisions v0x_right - supports reversible, single-encoder v0.x PCB revisions v0x_dualencoder - supports dual-encoder v0.x PCB revisions v1x - supports single-encoder v1.x PCB revisiions v1x_right - supports reversible, single-encoder v1.x PCB revisions * Added info.json and readme.md files for all dumbpad revisions * More refactoring, adding shared config.h and rules.mk Removed config.h from default keymap folders - defining TAPPING_TOGGLE in config.h * Minor formatting fix * MATRIX_COL_PINS for v1x_right was not reversed - changed to match v0x_right * adding support for v1x dual encoder PCB * adding alt-f2 tapdance routine for personal keymaps * adding dumbpad build using teensy 2.0 instead of Pro Micro * matched v1x dumbpad encoder and led pins to latest PCB revisions * updated readme, removed v1x_teensy until someone requests it * changed device name to match tmk udev rules, removed unnecessary ifdef * removed user keymaps and folders * missed hotdox keymap - removing * fixing info.json keyboard_names for all versions * Changed biton32 to get_highest_layer in keyboards/dumbpad/v0x/v0x.c * keyboards/dumbpad/v0x/v0x.c - remove matrix_scan_kb, process_record_kb * /dumbpad/v0x/keymaps/default/keymap.c - remove empty functions * /dumbpad/v0x/keymaps/default/keymap.c - changed biton32 to get_highest_layer * keyboards/dumbpad/v0x_dualencoder/keymaps/default/keymap.c - remove empty functions * keyboards/dumbpad/v0x_right/readme.md - smaller board layout image * keyboards/dumbpad/v1x_dualencoder/readme.md - smaller board image * keyboards/dumbpad/v1x/readme.md - smaller board image * keyboards/dumbpad/v1x_right/readme.md - smaller board image * Update keyboards/dumbpad/rules.mk * Apply suggestions from code review Batch applying suggestions from review * fixed removal of led_set_kb * Implementing requested changes from old pull request 9259 * removing unused rules * removed rules.mk from dumbpad base folder * adding templates for each layout * testing default keymap json * Testing applying default keymap for dumbpad * Layout correction: v1.x are 17 position pcb's * Update keyboards/dumbpad/v0x/rules.mk * Update keyboards/dumbpad/v0x/rules.mk * Update keyboards/dumbpad/v0x_dualencoder/keymaps/default/keymap.c * Update keyboards/dumbpad/v0x_dualencoder/rules.mk * Update keyboards/dumbpad/v0x_dualencoder/rules.mk * Update keyboards/dumbpad/v1x_dualencoder/rules.mk * Update keyboards/dumbpad/v1x_dualencoder/templates/keymap.c * Update keyboards/dumbpad/v1x_right/rules.mk * Update keyboards/dumbpad/v1x_right/rules.mk * Update keyboards/dumbpad/rules.mk * Update keyboards/dumbpad/v0x_dualencoder/templates/keymap.c * Update keyboards/dumbpad/v0x_right/rules.mk * Update keyboards/dumbpad/v1x/rules.mk * Update keyboards/dumbpad/v1x/rules.mk * Update keyboards/dumbpad/v1x_dualencoder/keymaps/default/keymap.c * Update keyboards/dumbpad/v1x_dualencoder/rules.mk * Update keyboards/dumbpad/v0x_right/rules.mk * Removing binary files
Diffstat (limited to 'keyboards/dumbpad/readme.md')
-rw-r--r--keyboards/dumbpad/readme.md38
1 files changed, 21 insertions, 17 deletions
diff --git a/keyboards/dumbpad/readme.md b/keyboards/dumbpad/readme.md
index 8f3789bcb3..ad72ed58d8 100644
--- a/keyboards/dumbpad/readme.md
+++ b/keyboards/dumbpad/readme.md
@@ -1,19 +1,23 @@
# dumbpad
-![dumbpad](https://i.imgur.com/sS3fq1Z.jpg)
-
-A 4x4 macro/numpad with rotary encoder.
-
-Keyboard Maintainer: [imchipwood](https://github.com/imchipwood)
-
-PCB repository: https://github.com/imchipwood/dumbpad
-
-Make example for this keyboard (after setting up your build environment):
-
- make dumbpad:default
-
-Program with:
-
- make dumbpad: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).
+![dumbpad](https://i.imgur.com/1T7ciLZl.jpg)
+
+dumbpad is a num/macro pad available in two major form factors - single- and dual-rotary encoder.
+
+* Single-encoder PCBs are reversible - components can be soldered to either side to allow
+the encoder to be on either the left or right side.
+* Dual-encoder PCBs come in two versions - one with the encoders in the bottom corners, the otherin the top corners
+
+Support for dumbpad all PCB revisions can be found in this directory.
+
+* Maintainer: [imchipwood](https://github.com/imchipwood)
+* PCB repository: [dumbpad on github](https://github.com/imchipwood/dumbpad)
+ * PCB revisions:
+ * v0.x - these revisions have two LEDs for layer indication
+ * ['v0x'](v0x/): Default setup for single rotary encoder v0.x PCBs
+ * ['v0x_right'](v0x_right/): Same as v0x but with rotary encoder on right side (components on bottom of PCB)
+ * ['v0x_dualencoder'](v0x_dualencoder/): Dual-encoder PCBs
+ * v1.x - these revisions have three LEDs - two for layer indication, one for numlock indication
+ * ['v1x'](v1x/): Default setup for v1.x PCBs with a single rotary encoder on the left side
+ * ['v1x_right'](v1x_right/): Same as v1x but with rotary encoder on right side (components on bottom of PCB)
+ * ['v1x_dualencoder'](v1x_dualencoder/): v1x PCB with two rotary encoders