summaryrefslogtreecommitdiff
path: root/keyboards/adpenrose/kintsugi/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-12-25 01:35:05 +0000
committerQMK Bot <hello@qmk.fm>2021-12-25 01:35:05 +0000
commitd6b9056d427d22af12b63952b6d60920cb8354db (patch)
treed6496e5af7a9ca90cc45de3ccd3a222b7b31566e /keyboards/adpenrose/kintsugi/readme.md
parentc734e7c1bfa43f47998c868113bf899e6cccb09b (diff)
parent36db7457b299d91f665f931a5f60bd059ada0210 (diff)
downloadqmk_firmware-d6b9056d427d22af12b63952b6d60920cb8354db.tar.gz
qmk_firmware-d6b9056d427d22af12b63952b6d60920cb8354db.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/adpenrose/kintsugi/readme.md')
-rw-r--r--keyboards/adpenrose/kintsugi/readme.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/keyboards/adpenrose/kintsugi/readme.md b/keyboards/adpenrose/kintsugi/readme.md
new file mode 100644
index 0000000000..2aa402543e
--- /dev/null
+++ b/keyboards/adpenrose/kintsugi/readme.md
@@ -0,0 +1,37 @@
+# Kintsugi
+
+![kintsugi](https://i.imgur.com/HPdmzdCl.jpeg)
+
+A 65%-ish keyboard with some extra features.
+
+## Features
+
+* Powered by an ATmega32u4 microcontroller (current version needs an Elite-C to work).
+* Encoder.
+* OLED screen.
+* Underglow.
+* Hotswap sockets.
+
+## General info
+
+* Keyboard Maintainer: [Arturo Avila](https://github.com/ADPenrose)
+* Hardware Supported: Kintsugi V1 PCB
+* Hardware Availability: [Arturo Avila](https://github.com/ADPenrose)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kintsugi:default
+
+Flashing example for this keyboard:
+
+ make kintsugi: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 front of the Elite-C microcontroller _**before soldering**_ it to the PCB- some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available