summaryrefslogtreecommitdiffstats
path: root/keyboards/candybar/righty/readme.md
diff options
context:
space:
mode:
authorTerryMathews <terry@terrymathews.net>2020-03-12 15:52:59 -0400
committerGitHub <noreply@github.com>2020-03-12 19:52:59 +0000
commit18bc5254932a842276627d8f055b6fb1d3345230 (patch)
tree0b8d831958384bb146dd0af751806e44cdbd691a /keyboards/candybar/righty/readme.md
parent4edb5a5e8c72e3be7fda20069941ea215cb49916 (diff)
[Keyboard] Candybar update (#8335)
* Candybar: split lefty and righty into subprojects. * Update readme.md * Update readme.md * Candybar: Moved STM32 library files into project root folder. * Update keyboards/candybar/righty/readme.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/candybar/righty/readme.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/candybar/righty/readme.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/candybar/righty/readme.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/candybar/righty/righty.c Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Candybar: remove Boards directory so project uses one from drivers * Update keyboards/candybar/righty/readme.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Update readme.md * Update readme.md Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Diffstat (limited to 'keyboards/candybar/righty/readme.md')
-rw-r--r--keyboards/candybar/righty/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/candybar/righty/readme.md b/keyboards/candybar/righty/readme.md
new file mode 100644
index 0000000000..d3aa867303
--- /dev/null
+++ b/keyboards/candybar/righty/readme.md
@@ -0,0 +1,15 @@
+# The Key Company Candybar
+
+![Candybar](https://cdn.shopify.com/s/files/1/1679/2319/articles/CandyBar_Promo_400x225_1000x.jpg?v=1538150501)
+
+The Key Company Candybar is a staggered 40% board with a numpad utilizing the STM32F072 microcontroller.
+
+* Keyboard Maintainer: [Terry Mathews](https://github.com/TerryMathews/)
+* Hardware Supported: TKC Candybar
+* Hardware Availability: [TheKey.Company](https://thekey.company/collections/candybar)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make candybar/righty:default:dfu-util
+
+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).