summaryrefslogtreecommitdiff
path: root/keyboards/enviousdesign/mcro/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/enviousdesign/mcro/readme.md')
-rw-r--r--keyboards/enviousdesign/mcro/readme.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/enviousdesign/mcro/readme.md b/keyboards/enviousdesign/mcro/readme.md
new file mode 100644
index 0000000000..378fab8c3e
--- /dev/null
+++ b/keyboards/enviousdesign/mcro/readme.md
@@ -0,0 +1,30 @@
+# EnvKB MCRO
+
+![Image of EnvKB MCRO PCB](https://i.imgur.com/QnANWnBh.png)
+
+A small 12 Key macro pad for various uses
+
+* Keyboard Maintainer: [Envious-Data](https://github.com/envious-data)
+* Hardware Supported: EnvKB MCRO (Pi Pico)
+* Hardware Availability: [GitHub](https://github.com/Envious-Data/Env-MCRO)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make enviousdesign/mcro:default
+
+Flashing example for this keyboard:
+
+ make enviousdesign/mcro: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 top left key and plug in the keyboard. This will also clear the emulated EEPROM, so it is a good first step if the keyboard is misbehaving.
+* **Physical reset**: Hold down the `BOOTSEL` button on the Pi Pico, then either plug the board in or press the `RESET` button.
+* **Keycode in layout**: There is no key mapped to `QK_BOOT` in the pre-created keymaps, but you may assign this key in any keymaps you create.
+
+After entering the bootloader through one of the three methods above, the keyboard will appear as a USB mass storage device named `RPI-RP2`. If the CLI is unable to find this device, the compiled `.uf2` file can be manually copied to it. The keyboard will reboot on completion with the new firmware loaded.
+