summaryrefslogtreecommitdiff
path: root/keyboards/minimacro5/readme.md
diff options
context:
space:
mode:
authordezli <29718605+dezlidezlidezli@users.noreply.github.com>2020-09-22 13:03:03 +0800
committerGitHub <noreply@github.com>2020-09-21 22:03:03 -0700
commitbfbcfbc83e9c496abff002726f7cc07108d99003 (patch)
treea22a1497bfe9b24fc390cdaacd25e0fc2393d21a /keyboards/minimacro5/readme.md
parent967ed19d77ce6793dac6cd94e294fe9edff5a39b (diff)
[Keyboard] Add miniMACRO5 Macropad (#10392)
* add miniMACRO5 add all nessecary files for the miniMACRO5 I have rewritten the readme, and changed the keymaps to be more simple. I have tested compiling, and everything works perfectly. * update miniMACRO5 readme add the make example into the readme file * Update keyboards/minimacro5/config.h Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/minimacro5/keymaps/default/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/minimacro5/keymaps/media/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/minimacro5/keymaps/media/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/minimacro5/minimacro5.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/minimacro5/info.json Co-authored-by: Ryan <fauxpark@gmail.com> * Apply suggestions from code review applied all suggestions. Co-authored-by: Ryan <fauxpark@gmail.com> * drashna suggestions - enum rather than define committed enum update by drashna Co-authored-by: Drashna Jaelre <drashna@live.com> * update keymap.c incorrect brackets Co-authored-by: dezli <m@dez.li> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/minimacro5/readme.md')
-rw-r--r--keyboards/minimacro5/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/minimacro5/readme.md b/keyboards/minimacro5/readme.md
new file mode 100644
index 0000000000..6266d2ba35
--- /dev/null
+++ b/keyboards/minimacro5/readme.md
@@ -0,0 +1,15 @@
+# miniMACRO5
+
+A 5 key Macropad based on Arduino Pro Micro with support for a combination of rotary encoders and mechanical switches.
+
+![](https://i.imgur.com/lxA8DSCl.jpg)
+
+* Keyboard Maintainer: [LeafCutterLabs](https://github.com/LeafCutterLabs)
+* Hardware Supported: Pro Micro 5V/16MHz and compatible.
+* Hardware availability: PCB Files are available [here](https://github.com/LeafCutterLabs/miniMACRO5), which you can get produced.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make minimacro5: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).