qmk-firmware/keyboards/compound/readme.md
Rafael Yumagulov e08203f16a
[Keyboard] Added Compound keyboard support (#12942)
* [Keyboard] Added Compound keyboard support

* Small fixes for Compound keyboard

* Fixed readme and header file for Compound keyboard

* Update keyboards/compound/rules.mk

Co-authored-by: Ryan <fauxpark@gmail.com>

* Changed info.json and readme.md for Compound Keyboard

info.json - removed key_count
readme.md - changed PCB picture url to low-resolution

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: Ryan <fauxpark@gmail.com>
2021-07-23 20:45:24 -07:00

31 lines
1.0 KiB
Markdown

# Compound
![Compound](https://imgur.com/0DC9F9dh.jpg)
A compact 60% Compound keyboard with fixed Tsangan style layout.
* Keyboard Maintainer: [yumagulovrn](https://github.com/yumagulovrn)
* Hardware Supported: Compound PCB
* Hardware Availability: [GeekHack IC](https://geekhack.org/index.php?topic=111187.0)
## Entering bootloader mode
Keyboard doesn't have dedicated RESET button on the PCB, however, there are alternatives:
### Bootmagic
Hold down ESC while plugging the keyboard in.
### Shorting RESET pin
Short GND and RST pads on the bottom of the keyboard. Location of the pads can be seen [here](https://imgur.com/uw7Zz7Y.jpg).
## Building keyboard firmware
Make example for this keyboard (after setting up your build environment):
make compound: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).