summaryrefslogtreecommitdiffstats
path: root/keyboards/tkc/candybar/righty_r3/readme.md
diff options
context:
space:
mode:
authorTerryMathews <terry@terrymathews.net>2022-01-10 20:31:16 -0500
committerGitHub <noreply@github.com>2022-01-10 17:31:16 -0800
commit6acfb61159cc055deeba219d398ebce95e114431 (patch)
tree79028b6d41a00c4ed3c35d8afd6208dbc99d931c /keyboards/tkc/candybar/righty_r3/readme.md
parent951fa1020b5c57bca656c25e20c8e12da8610f41 (diff)
[Keyboard] TKC Candybar R3 (#15374)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Diffstat (limited to 'keyboards/tkc/candybar/righty_r3/readme.md')
-rw-r--r--keyboards/tkc/candybar/righty_r3/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/tkc/candybar/righty_r3/readme.md b/keyboards/tkc/candybar/righty_r3/readme.md
new file mode 100644
index 0000000000..e91a0015e9
--- /dev/null
+++ b/keyboards/tkc/candybar/righty_r3/readme.md
@@ -0,0 +1,22 @@
+# TheKey.Company Candybar
+
+![Candybar](https://cdn.shopify.com/s/files/1/1679/2319/products/CBR3CollectionHERO_720x.jpg)
+
+The Key Company Candybar is a staggered 40% board with a numpad utilizing the ATmega32u4 microcontroller.
+
+* Keyboard Maintainer: [Terry Mathews](https://github.com/TerryMathews/)
+* Hardware Supported: TKC Candybar
+* Hardware Availability: [TheKey.Company](https://thekey.company/products/candybar-round-3)
+
+## Bootloader
+
+Enter the bootloader in 2 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (default Escape key) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make tkc/candybar/righty_r3: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).