diff options
| author | Rafael Yumagulov <yumagulovrn@gmail.com> | 2021-07-24 06:45:24 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-23 20:45:24 -0700 |
| commit | e08203f16a5d9b69abea796583491d4b2de3aa6b (patch) | |
| tree | c35edd5b772b468fbe970030113540326d070497 /keyboards/compound/readme.md | |
| parent | 4a47ee937db397b32387b5d71851569cdfc8a8d2 (diff) | |
[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>
Diffstat (limited to 'keyboards/compound/readme.md')
| -rw-r--r-- | keyboards/compound/readme.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/compound/readme.md b/keyboards/compound/readme.md new file mode 100644 index 0000000000..9422939ac8 --- /dev/null +++ b/keyboards/compound/readme.md @@ -0,0 +1,30 @@ +# Compound + + + +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). |