summaryrefslogtreecommitdiff
path: root/keyboards/custommk/genesis/rev1/readme.md
diff options
context:
space:
mode:
authorDavid Hoelscher <infinityis@users.noreply.github.com>2021-08-12 10:51:34 -0500
committerGitHub <noreply@github.com>2021-08-12 08:51:34 -0700
commit541e749aa894c526217b68314df1621f812411b6 (patch)
treea06035aeeb5406beb0da0f56bc37cee0bae6f603 /keyboards/custommk/genesis/rev1/readme.md
parent74aff52bff3800aee75611bd444e1f85f2877bb6 (diff)
[Keyboard] Update to customMK Genesis (#12511)
Co-authored-by: Ray <ray@custommk.com>
Diffstat (limited to 'keyboards/custommk/genesis/rev1/readme.md')
-rw-r--r--keyboards/custommk/genesis/rev1/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/custommk/genesis/rev1/readme.md b/keyboards/custommk/genesis/rev1/readme.md
new file mode 100644
index 0000000000..bba03cceb8
--- /dev/null
+++ b/keyboards/custommk/genesis/rev1/readme.md
@@ -0,0 +1,19 @@
+# Genesis
+
+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/rev1:default
+
+Flashing example for this keyboard:
+
+ make custommk/genesis/rev1: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).