summaryrefslogtreecommitdiff
path: root/keyboards/macro3/readme.md
diff options
context:
space:
mode:
authorAlbert Y <76888457+filterpaper@users.noreply.github.com>2021-11-16 09:05:15 +0800
committerGitHub <noreply@github.com>2021-11-15 17:05:15 -0800
commit22eba600418696542a6b84125f4dff2f37638c1e (patch)
tree7bbc86cb9d13596abfc905b78c8a397c2b41753f /keyboards/macro3/readme.md
parentd3ae937b50df8d98deb3dc3b9f8aa1635eac1c8b (diff)
[Keyboard] Add macro3 PCB support (#15131)
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: filterpaper <filterpaper@localhost>
Diffstat (limited to 'keyboards/macro3/readme.md')
-rw-r--r--keyboards/macro3/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/macro3/readme.md b/keyboards/macro3/readme.md
new file mode 100644
index 0000000000..66a142ecdf
--- /dev/null
+++ b/keyboards/macro3/readme.md
@@ -0,0 +1,26 @@
+# Macro3
+
+![Macro3](https://github.com/davidphilipbarr/Macropads/raw/main/macro3/IMG_20200703_170424.jpg)
+
+Macro3 is a low-profile macro pad with encoder support designed by [@davidphilipbarr](https://github.com/davidphilipbarr) using direct micro-controller pin wiring.
+
+## Keyboard Info
+
+* Keyboard Maintainer: [davidphilipbarr](https://github.com/davidphilipbarr)
+* Hardware Supported: [Macro3](https://github.com/davidphilipbarr/Macropads/tree/main/macro3)
+* Hardware Availability: order PCBs with gerber file from the repository
+
+Make example for this keyboard (after setting up your build environment):
+
+ make macro3:default
+
+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 right key and plug in the controller.
+* **Physical reset button**: Briefly press the reset button soldered on the PCB.
+* **Keycode in layout**: Press the key mapped to `RESET` if it is configured.
+