summaryrefslogtreecommitdiffstats
path: root/keyboards/cannonkeys/onyx/readme.md
diff options
context:
space:
mode:
authorAndrew Kannan <andrew.kannan@klaviyo.com>2021-01-11 01:18:01 -0500
committerGitHub <noreply@github.com>2021-01-10 22:18:01 -0800
commit65d8ac47598aa4aa439181627743749d18a19558 (patch)
tree82158d8d82b7ab47c3d4bf36c45bfda4ed5b2708 /keyboards/cannonkeys/onyx/readme.md
parent8657f54f9eee97c1905b8fa347497a518f147455 (diff)
[Keyboard] Add Onyx keyboard to QMK (#11292)
* Add Onyx keyboard to QMK * Apply suggestions from code review Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/cannonkeys/onyx/readme.md')
-rw-r--r--keyboards/cannonkeys/onyx/readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/onyx/readme.md b/keyboards/cannonkeys/onyx/readme.md
new file mode 100644
index 0000000000..4c2ad15745
--- /dev/null
+++ b/keyboards/cannonkeys/onyx/readme.md
@@ -0,0 +1,12 @@
+# Onyx by Funderburker
+
+Onyx Keyboard
+
+* Keyboard Maintainer: [Andrew Kannan](https://github.com/awkannan)
+* Hardware Supported: STM32F072CBT6
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cannonkeys/onyx:default
+
+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).