diff options
author | etiennelepagel <50152897+etiennelepagel@users.noreply.github.com> | 2021-10-11 22:42:14 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-11 19:42:14 -0700 |
commit | a0b7c1618af74cc1e18a482ac79ed1ddedcda2df (patch) | |
tree | 925cebf4470e7beee8531dc0b653adf3b9f99a74 /keyboards/machkeyboards/mach3/readme.md | |
parent | 2d8dcf08e8981a30f2430a8794ff5013c56cfdd4 (diff) |
[Keyboard] Add MachKeyboards Mach3 (#14791)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/machkeyboards/mach3/readme.md')
-rw-r--r-- | keyboards/machkeyboards/mach3/readme.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/machkeyboards/mach3/readme.md b/keyboards/machkeyboards/mach3/readme.md new file mode 100644 index 0000000000..16c61511b1 --- /dev/null +++ b/keyboards/machkeyboards/mach3/readme.md @@ -0,0 +1,22 @@ +# Mach 3 + +A 3x3 macropad with RGB underglow. +Note: It sets an output pin to high, which is the alimentation of the backlight circuit. + +* Keyboard Maintainer: [etiennelepagel](https://github.com/etiennelepagel) +* Hardware Supported: Mach 3 from Mach Keyboards +* Hardware Availability: [Mach Keyboards Official Website](https://machkeyboards.com/) + +## 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 +* **Keycode in layout**: Press the key mapped to `RESET` if it is available + +Make example for this keyboard (after setting up your build environment): + + make machkeyboards/mach3: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). |