diff options
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 000000000..9422939ac --- /dev/null +++ b/keyboards/compound/readme.md | |||
| @@ -0,0 +1,30 @@ | |||
| 1 | # Compound | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | A compact 60% Compound keyboard with fixed Tsangan style layout. | ||
| 6 | |||
| 7 | * Keyboard Maintainer: [yumagulovrn](https://github.com/yumagulovrn) | ||
| 8 | * Hardware Supported: Compound PCB | ||
| 9 | * Hardware Availability: [GeekHack IC](https://geekhack.org/index.php?topic=111187.0) | ||
| 10 | |||
| 11 | ## Entering bootloader mode | ||
| 12 | |||
| 13 | Keyboard doesn't have dedicated RESET button on the PCB, however, there are alternatives: | ||
| 14 | |||
| 15 | ### Bootmagic | ||
| 16 | |||
| 17 | Hold down ESC while plugging the keyboard in. | ||
| 18 | |||
| 19 | ### Shorting RESET pin | ||
| 20 | |||
| 21 | Short GND and RST pads on the bottom of the keyboard. Location of the pads can be seen [here](https://imgur.com/uw7Zz7Y.jpg). | ||
| 22 | |||
| 23 | |||
| 24 | ## Building keyboard firmware | ||
| 25 | |||
| 26 | Make example for this keyboard (after setting up your build environment): | ||
| 27 | |||
| 28 | make compound:default | ||
| 29 | |||
| 30 | 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). | ||
