diff options
| author | Michał Szczepaniak <m.szczepaniak.000@gmail.com> | 2022-02-05 15:27:41 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-05 14:27:41 +0000 |
| commit | df371257552d9b8a9e290d8ddd120ea96f3dd9e6 (patch) | |
| tree | 50872d9a28e03274ba8b2a1d340e0e47c978541f /keyboards/handwired/macroboard/readme.md | |
| parent | 10fda3ec8e4ee0a74bb4e8c0f41e554fb7344e78 (diff) | |
Add macroboard(5x6 OLKB blackpill) keyboard (#16219)
* Add macroboard keyboard
* Fix issues requested in pull request
* Removed halconf/mcuconf and moved to handwired directory
* Added description, enabled bootmagic, disabled console
* Apply suggestions from code review
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/handwired/macroboard/readme.md')
| -rw-r--r-- | keyboards/handwired/macroboard/readme.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/handwired/macroboard/readme.md b/keyboards/handwired/macroboard/readme.md new file mode 100644 index 0000000000..ee2351f99f --- /dev/null +++ b/keyboards/handwired/macroboard/readme.md @@ -0,0 +1,27 @@ +# macroboard + + + +3D printable half preonic (5x6 OLKB) with purpose of being macroboard or if you want to have different switches for gaming while having normal full keyboard for typing. + +* Keyboard Maintainer: [Michał Szczepaniak](https://github.com/Michal-Szczepaniak) +* Hardware Supported: Blackpill +* Hardware Availability: [OpenSCAD files](https://github.com/Michal-Szczepaniak/macroboard-openscad) + +Make example for this keyboard (after setting up your build environment): + + make handwired/macroboard:default + +Flashing example for this keyboard: + + make handwired/macroboard: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 `RESET` if it is available, by default 5th column, 5th row |