aboutsummaryrefslogtreecommitdiff
path: root/keyboards/macro3/readme.md
diff options
context:
space:
mode:
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 000000000..66a142ecd
--- /dev/null
+++ b/keyboards/macro3/readme.md
@@ -0,0 +1,26 @@
1# Macro3
2
3![Macro3](https://github.com/davidphilipbarr/Macropads/raw/main/macro3/IMG_20200703_170424.jpg)
4
5Macro3 is a low-profile macro pad with encoder support designed by [@davidphilipbarr](https://github.com/davidphilipbarr) using direct micro-controller pin wiring.
6
7## Keyboard Info
8
9* Keyboard Maintainer: [davidphilipbarr](https://github.com/davidphilipbarr)
10* Hardware Supported: [Macro3](https://github.com/davidphilipbarr/Macropads/tree/main/macro3)
11* Hardware Availability: order PCBs with gerber file from the repository
12
13Make example for this keyboard (after setting up your build environment):
14
15 make macro3:default
16
17See 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).
18
19## Bootloader
20
21Enter the bootloader in 3 ways:
22
23* **Bootmagic reset**: Hold down the top right key and plug in the controller.
24* **Physical reset button**: Briefly press the reset button soldered on the PCB.
25* **Keycode in layout**: Press the key mapped to `RESET` if it is configured.
26