diff options
Diffstat (limited to 'keyboards/takashicompany/compacx/readme.md')
| -rw-r--r-- | keyboards/takashicompany/compacx/readme.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/takashicompany/compacx/readme.md b/keyboards/takashicompany/compacx/readme.md new file mode 100644 index 000000000..ac5cfee16 --- /dev/null +++ b/keyboards/takashicompany/compacx/readme.md | |||
| @@ -0,0 +1,29 @@ | |||
| 1 | # Compacx | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | "Compacx" is a 35-key keyboard with an ISO enter key. | ||
| 6 | It is the perfect size for a macro pad or a one-handed gaming keyboard. | ||
| 7 | It can also be used as a split keyboard by combining two units. | ||
| 8 | |||
| 9 | * Keyboard Maintainer: [takashicompany](https://github.com/takashicompany) | ||
| 10 | * Hardware Supported: PCB, Pro Micro | ||
| 11 | * Hardware Availability: https://github.com/takashicompany/compacx | ||
| 12 | |||
| 13 | Make example for this keyboard (after setting up your build environment): | ||
| 14 | |||
| 15 | make takashicompany/compacx:default | ||
| 16 | |||
| 17 | Flashing example for this keyboard: | ||
| 18 | |||
| 19 | make takashicompany/compacx:default:flash | ||
| 20 | |||
| 21 | 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). | ||
| 22 | |||
| 23 | ## Bootloader | ||
| 24 | |||
| 25 | Enter the bootloader in 3 ways: | ||
| 26 | |||
| 27 | * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard | ||
| 28 | * **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead | ||
| 29 | * **Keycode in layout**: Press the key mapped to `RESET` if it is available | ||
