summaryrefslogtreecommitdiff
path: root/keyboards/takashicompany/baumkuchen/readme.md
diff options
context:
space:
mode:
authortakashicompany <t@kashi.company>2023-07-04 05:55:12 +0900
committerGitHub <noreply@github.com>2023-07-03 13:55:12 -0700
commite423d5e3d4059b3c16358fc5b6b2fe673f204f54 (patch)
treea6b32e86cb4941b99545c7efeb4ea2a462924cd4 /keyboards/takashicompany/baumkuchen/readme.md
parent989f387d1838fc720a6f12f2ffde3acc0e4b1920 (diff)
[Keyboard] Add Baumkuchen (#20766)
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/takashicompany/baumkuchen/readme.md')
-rw-r--r--keyboards/takashicompany/baumkuchen/readme.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/takashicompany/baumkuchen/readme.md b/keyboards/takashicompany/baumkuchen/readme.md
new file mode 100644
index 0000000000..adc3f2e006
--- /dev/null
+++ b/keyboards/takashicompany/baumkuchen/readme.md
@@ -0,0 +1,31 @@
+# Baumkuchen
+
+![takashicompany/baumkuchen](https://i.imgur.com/NS39x44h.png)
+
+Baumkuchen is a 13-key macropad with a radial key layout.
+The board can be used as a circuit or as a switch plate by cutting out the keyswitch Pro Micro part.
+It is compatible with Cherry MX compatible keyswitches, and a rotary encoder can be optionally installed.
+LEDs can also be mounted to make it glow.
+The board is reversible, allowing you to choose the arrangement of keys and Pro Micro according to your usage style.
+
+* Keyboard Maintainer: [takashicompany](https://github.com/takashicompany)
+* Hardware Supported: Baumkuchen PCB, Pro Micro
+* Hardware Availability: https://github.com/takashicompany/baumkuchen
+
+Make example for this keyboard (after setting up your build environment):
+
+ make takashicompany/baumkuchen:default
+
+Flashing example for this keyboard:
+
+ make takashicompany/baumkuchen: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 `QK_BOOT` if it is available