qmk-firmware/keyboards/takashicompany/compacx/readme.md
takashicompany 8ce69e6a83
[Keyboard] Add new keyboard "Compacx" (#14903)
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
2021-11-03 22:26:18 -07:00

30 lines
1.3 KiB
Markdown

# Compacx
![image](https://github.com/takashicompany/compacx/blob/master/images/qmk.jpg?raw=true)
"Compacx" is a 35-key keyboard with an ISO enter key.
It is the perfect size for a macro pad or a one-handed gaming keyboard.
It can also be used as a split keyboard by combining two units.
* Keyboard Maintainer: [takashicompany](https://github.com/takashicompany)
* Hardware Supported: PCB, Pro Micro
* Hardware Availability: https://github.com/takashicompany/compacx
Make example for this keyboard (after setting up your build environment):
make takashicompany/compacx:default
Flashing example for this keyboard:
make takashicompany/compacx: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