summaryrefslogtreecommitdiff
path: root/keyboards/takashicompany/compacx/readme.md
diff options
context:
space:
mode:
authortakashicompany <t@kashi.company>2021-11-04 14:26:18 +0900
committerGitHub <noreply@github.com>2021-11-03 22:26:18 -0700
commit8ce69e6a8373abba52411989d16e6bbe8d575097 (patch)
treeb7a1e6170cb3b6c08987a7b67fa5a5290768c870 /keyboards/takashicompany/compacx/readme.md
parent3f33362740ff8cc8f0d96e99ace71fe82e62c30d (diff)
[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>
Diffstat (limited to 'keyboards/takashicompany/compacx/readme.md')
-rw-r--r--keyboards/takashicompany/compacx/readme.md29
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 0000000000..ac5cfee169
--- /dev/null
+++ b/keyboards/takashicompany/compacx/readme.md
@@ -0,0 +1,29 @@
+# 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