summaryrefslogtreecommitdiff
path: root/keyboards/yampad/readme.md
diff options
context:
space:
mode:
authorDaveyr <26368709+Daveyr@users.noreply.github.com>2021-05-14 03:00:25 +0100
committerGitHub <noreply@github.com>2021-05-13 19:00:25 -0700
commit0aaddf697fb977c8457f3b0231c2f007ac1e0fb9 (patch)
tree160a4b3ee1f1bc2541f89d7e828e87f2355d01f9 /keyboards/yampad/readme.md
parentcef1d19a6ceb2ce6adad1b336946bf357dbb487f (diff)
downloadqmk_firmware-0aaddf697fb977c8457f3b0231c2f007ac1e0fb9.tar.gz
qmk_firmware-0aaddf697fb977c8457f3b0231c2f007ac1e0fb9.zip
[Keyboard] added yampad configuration to keyboard subfolder (#10112)
* added yampad configuration to keyboard subfolder * Update keyboards/yampad/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/keymaps/default/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/keymaps/default/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/keymaps/default/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/keymaps/default/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * added debouncing algorithm, delay and a traditional layout * added link to readme * some missed conflicts resolved in readme and rule * Update readme.md * Update keyboards/yampad/keymaps/traditional/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/keymaps/traditional/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/keymaps/traditional/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/keymaps/traditional/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/keymaps/traditional/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/keymaps/traditional/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/keymaps/default/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/keymaps/traditional/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/keymaps/traditional/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yampad/keymaps/traditional/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/yampad.c As suggested Co-authored-by: Drashna Jaelre <drashna@live.com> * Update readme.md Updated per suggestion * Update keymap.c Add MIT licence * Update keymap.c Added MIT licence to the traditional layout. * Update keyboards/yampad/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yampad/yampad.c Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/yampad/yampad.c Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * make cases numerical in .c file * corrected the bootloader in rules.mk * Update keyboards/yampad/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Richard <davey.richard@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Diffstat (limited to 'keyboards/yampad/readme.md')
-rw-r--r--keyboards/yampad/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/yampad/readme.md b/keyboards/yampad/readme.md
new file mode 100644
index 0000000000..e6cc03d60d
--- /dev/null
+++ b/keyboards/yampad/readme.md
@@ -0,0 +1,19 @@
+# Yampad
+
+![yampad](https://github.com/mattdibi/yampad/blob/master/img/yampad.jpg)
+
+The Yampad project is an open-source, QMK (Quantum Mechanical Keyboard Firmware) powered, hot-swappable, RGB-backlighted, OLED featured, mechanical numpad. This repository will be used to share information about the project and instruction on how to use and assemble the Yampad.
+
+* Keyboard Maintainer: [mattdibi](https://github.com/mattdibi)
+* Hardware Supported: Pro Micro, (ATmega32u4)
+* Hardware Availability: https://github.com/mattdibi/yampad
+
+Make example for this keyboard (after setting up your build environment):
+
+ make yampad:default
+
+Flashing example for this keyboard:
+
+ make yampad:default:flash
+
+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).