summaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/6macro/readme.md
diff options
context:
space:
mode:
authorJoao Maia <jm@joao-maia.com>2019-07-18 20:31:40 +0100
committernoroadsleft <18669334+noroadsleft@users.noreply.github.com>2019-07-18 12:31:40 -0700
commit00c6892b3f8abc7d9b298d77cb965c9c242dd953 (patch)
treee25c2b7f2d525c45c2051662db884750b4f15c80 /keyboards/handwired/6macro/readme.md
parent171f7c561b8217ab4169c36e31fcdc05012c4add (diff)
[Keyboard] Add 6macro keyboard (#6362)
* Initial commit for 6macro firmware * Updated layout documentation * Removed unused commented code
Diffstat (limited to 'keyboards/handwired/6macro/readme.md')
-rw-r--r--keyboards/handwired/6macro/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/handwired/6macro/readme.md b/keyboards/handwired/6macro/readme.md
new file mode 100644
index 0000000000..3fbd917c80
--- /dev/null
+++ b/keyboards/handwired/6macro/readme.md
@@ -0,0 +1,15 @@
+# 6macro
+
+![6macro photo](https://raw.githubusercontent.com/joaofbmaia/6macro/master/photo.jpg)
+![6macro photo with RGB](https://raw.githubusercontent.com/joaofbmaia/6macro/master/photo_rgb.jpg)
+
+This is a 6-key keyboard intended for macros or as a dedicated controller for games with few bindings.
+
+Keyboard Maintainer: [joaofbmaia](https://github.com/joaofbmaia)
+Hardware: https://github.com/joaofbmaia/6macro
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/6macro: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).