summaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/2x5keypad/readme.md
diff options
context:
space:
mode:
authorJonathan Cameron <jmcameron@gmail.com>2019-09-09 22:03:33 -0700
committerDrashna Jaelre <drashna@live.com>2019-09-09 22:03:33 -0700
commit2e521b509ce0c853b2e62d1d16e0117b900ab9c2 (patch)
treec795ea9e11322edaebdd7cde506fb6014cebb8cf /keyboards/handwired/2x5keypad/readme.md
parent00225b77e54fdc893f6c64768e1bffaa01df5849 (diff)
[Keyboard] Added a simple 2x5 Keypad with 4 layers (#6699)
* Added new 2x5 Keypad with 3 LEDs to indicate the selected layer. By Jonathan Cameron. * Minor refactor from suggestions from qmk team * Added * Moved to 'handwired' directory * Update readme.md * Update readme.md * Update readme.md * Update keyboards/handwired/2x5keypad/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Switch to image offsite * Moved image offsite * Update keyboards/handwired/2x5keypad/keymaps/default/keymap.h Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/handwired/2x5keypad/2x5keypad.h Co-Authored-By: fauxpark <fauxpark@gmail.com> * Moved functions into .c file per suggestions * Cosmetic * Fixed function called, per suggestions. * Update keyboards/handwired/2x5keypad/2x5keypad.h Ok Co-Authored-By: fauxpark <fauxpark@gmail.com> * Moved LED functions to the top level since they can be used it various flavors * Declare those moved LED functions! * Update keyboards/handwired/2x5keypad/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/handwired/2x5keypad/readme.md')
-rw-r--r--keyboards/handwired/2x5keypad/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/handwired/2x5keypad/readme.md b/keyboards/handwired/2x5keypad/readme.md
new file mode 100644
index 0000000000..d87a2e0178
--- /dev/null
+++ b/keyboards/handwired/2x5keypad/readme.md
@@ -0,0 +1,26 @@
+# 2x5keypad
+
+![2x5keypad](http://jmcameron.net/2x5keypad-small.jpg)
+
+This Keypad has 2 rows x 5 columns of keys. It has the top/default layer that
+has a few handy navigation keys as well as one dedicated key to cycle through
+the layers. The second layer has some media keys. The third and fourth layers
+are currently undefined (although I may use them for inserting accented French
+characters). The keypad also includes three LEDs that show which layer is
+active (no lit LEDs means the default layer).
+
+Keyboard Maintainer: [Jonathan Cameron](https://github.com/jmcameron)
+
+Hardware:
+ * Key switch holes cut in blank piece of copper-clad project board
+ * Uses Kailh Box White switches with relegendable keycaps
+ * Chassis is three layers of wood
+ * Handwired
+ * Uses a Pro Micro
+ * Includes a reset switch accessible by a hole on the bottom
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/2x5keyapd: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).