summaryrefslogtreecommitdiff
path: root/keyboards/opendeck/readme.md
diff options
context:
space:
mode:
authorCmdr. Emily <68452184+cmdremily@users.noreply.github.com>2020-10-18 09:37:02 +0200
committerGitHub <noreply@github.com>2020-10-18 18:37:02 +1100
commitf952d4f7b779474918453b7ec3ccccdcfbd63b58 (patch)
treee8618b97336dc35994caba814885d61d68ce295b /keyboards/opendeck/readme.md
parent8be058d55d2a50065294bac8e63020dbedae3f36 (diff)
Support OpenDeck 32 keyboard (#10305)
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/opendeck/readme.md')
-rw-r--r--keyboards/opendeck/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/opendeck/readme.md b/keyboards/opendeck/readme.md
new file mode 100644
index 0000000000..fb2d01e880
--- /dev/null
+++ b/keyboards/opendeck/readme.md
@@ -0,0 +1,19 @@
+# OpenDeck
+
+A OSH/OSW stream deck for streamers
+
+* Keyboard Maintainer: [cmdremily](https://github.com/cmdremily/)
+* Hardware Supported: OpenDeck32
+* Hardware Availability: [OSH on GitHub](https://github.com/cmdremily/OpenDeck)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make opendeck/32/rev1:default
+
+Flashing example for this keyboard:
+
+ make opendeck/32/rev1:default:flash
+
+then press the reset switch on the PCB.
+
+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).