summaryrefslogtreecommitdiff
path: root/keyboards/custommk/genesis/readme.md
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2020-12-09 18:21:45 +1100
committerfauxpark <fauxpark@gmail.com>2020-12-09 18:21:45 +1100
commit95c39b372744bbb8733d39a9b6e3c2d274fdfc79 (patch)
treee6f039ac9a536b7b206ebae8e5034bd5d8e2f2d4 /keyboards/custommk/genesis/readme.md
parenteb3964bd576568d577dc90704c7f2497de9a5aa9 (diff)
parent56933b9b9f00a46980c1201a6ba5d0c5c9932275 (diff)
Merge remote-tracking branch 'upstream/master' into develop
Diffstat (limited to 'keyboards/custommk/genesis/readme.md')
-rw-r--r--keyboards/custommk/genesis/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/custommk/genesis/readme.md b/keyboards/custommk/genesis/readme.md
new file mode 100644
index 0000000000..58bd27121a
--- /dev/null
+++ b/keyboards/custommk/genesis/readme.md
@@ -0,0 +1,22 @@
+# Genesis
+
+![Genesis Macro Pad](https://i.imgur.com/voBjLrM.jpeg)
+![Genesis Macro Pad PCB](https://i.imgur.com/ST2vtkV.jpeg)
+
+Genesis is a 5x4 ortholinear macro pad designed and produced by customMK.
+
+* Keyboard Maintainer: [customMK](https://github.com/customMK)
+* Hardware Supported: Genesis Macro Pad
+* Hardware Availability: [customMK](https://shop.custommk.com/products/genesis_macropad)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make custommk/genesis:default
+
+Flashing example for this keyboard:
+
+ make custommk/genesis:default:flash
+
+Genesis Macro Pad has qmk-dfu bootloader preinstalled. To enter the bootloader, run the flashing command above, and then either plug in the USB connection while holding the top-left key, or alternatively, plug in the USB connection and then press the reset button on the PCB
+
+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).