aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/anavi/macropad8/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/anavi/macropad8/readme.md')
-rw-r--r--keyboards/anavi/macropad8/readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/anavi/macropad8/readme.md b/keyboards/anavi/macropad8/readme.md
new file mode 100644
index 000000000..20af44585
--- /dev/null
+++ b/keyboards/anavi/macropad8/readme.md
@@ -0,0 +1,18 @@
+# ANAVI Macro Pad 8
+
+
+ANAVI Macro Pad 8 is an open source mini mechanical keyboard with 8 keys, backlit, addressable RGB WS2812B LED strip on the back and mini OLED display. Powered by ATmega32U4 microcontroller and with microUSB connector.
+
+* Keyboard Maintainer: [Leon Anavi](https://github.com/leon-anavi)
+* Hardware Supported: ANAVI Macro Pad 8
+* Hardware Availability: [PCB Files](https://github.com/AnaviTechnology/anavi-macro-pad-8)
+
+Make example for this keyboard (after setting up your build environment):
+
+ qmk compile -kb anavi/macropad8 -km default
+
+Flash to ANAVI Macro Pad 8:
+
+ qmk flash -kb anavi/macropad8 -km 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).