aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/macroflow_original/readme.md
diff options
context:
space:
mode:
authorPatrickemm2024-12-06 06:43:35 +0100
committerGitHub2024-12-06 06:43:35 +0100
commit03937e0c86109b7a488794bb8568d53d48d4ed16 (patch)
tree698b5c0ef7a3963c1272c8efe454733d54b991f9 /keyboards/macroflow_original/readme.md
parent09fdabf37c5004b1a580d32f61dd093625e62f8a (diff)
Add Macroflow Original macropad firmware (#24538)
* Adding Macroflow Macropad * Macroflow_Macropad * Macroflow_Macropad * Adding My Macropad * Adding Macroflow Macropad * Adding Macroflow Macropad * Adding Macroflow Macropad * Adding Macroflow Macropad * Adding Macroflow Macropad * Added License Headers * Updated code for merge * Added License Header * Added Encoder Map * Updated Files * Fixed Matrix * Update keyboards/macroflow_original/keyboard.json Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/macroflow_original/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/macroflow_original/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/macroflow_original/keymaps/default/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/macroflow_original/macroflow_original.c Co-authored-by: Drashna Jaelre <drashna@live.com> --------- Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/macroflow_original/readme.md')
-rw-r--r--keyboards/macroflow_original/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/macroflow_original/readme.md b/keyboards/macroflow_original/readme.md
new file mode 100644
index 0000000000..a38fefa866
--- /dev/null
+++ b/keyboards/macroflow_original/readme.md
@@ -0,0 +1,27 @@
+# macroflow_original
+
+![Imgur](https://i.imgur.com/hIytJTl.png)
+
+*A 2x4 macropad with a built in encoder and OLED screen*
+
+* Keyboard Maintainer: [Patrickemm](https://github.com/Patrickemm)
+* Hardware Supported: *Pro Micro compatible development board*
+* Hardware Availability: *https://www.ebay.com/usr/handycache*
+
+Make example for this keyboard (after setting up your build environment):
+
+ make macroflow_original:default
+
+Flashing example for this keyboard:
+
+ make macroflow_original: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 `QK_BOOT` if it is available