summaryrefslogtreecommitdiff
path: root/keyboards/machine_industries/m4_a/readme.md
diff options
context:
space:
mode:
authorJason Barnachea <jrbarnachea@gmail.com>2022-03-08 13:24:06 -0800
committerGitHub <noreply@github.com>2022-03-08 21:24:06 +0000
commitd38696a4937525d34445bf23863f99675ec2f54c (patch)
tree3f8c1ccfd683a4a11a6671a51f5e2cdc91a61bd6 /keyboards/machine_industries/m4_a/readme.md
parentb593cfccbde7b4fa7feb0e756eb601f7717bed98 (diff)
downloadqmk_firmware-d38696a4937525d34445bf23863f99675ec2f54c.tar.gz
qmk_firmware-d38696a4937525d34445bf23863f99675ec2f54c.zip
[Keyboard] Add Rama Works M4-A (#16570)
* Initial commit Add Rama Works M4-A keyboard. * Update default keymap.c * Update keyboards/machine_industries/m4_a/config.h Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/machine_industries/m4_a/readme.md')
-rw-r--r--keyboards/machine_industries/m4_a/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/machine_industries/m4_a/readme.md b/keyboards/machine_industries/m4_a/readme.md
new file mode 100644
index 0000000000..37c16639d1
--- /dev/null
+++ b/keyboards/machine_industries/m4_a/readme.md
@@ -0,0 +1,27 @@
+# Rama Works x Machine Industries M4-A
+
+![Rama Works x Machine Industries M4-A](https://images.squarespace-cdn.com/content/v1/563c788ae4b099120ae219e2/1479361502907-WL2VUR210J6RFD84WH2E/image-asset.jpeg?format=1500w)
+
+A tiny 4-key macropad designed by Rama Works.
+
+* Keyboard Maintainer: [naut](https://github.com/nautxx)
+* Hardware Supported: Rama Works x Machine Industries M4-A PCB
+* Hardware Availability: [Rama Works Store](https://ramaworks.store/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make machine_industries/m4_a:default
+
+Flashing example for this keyboard:
+
+ make machine_industries/m4_a:default:flash
+
+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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available