summaryrefslogtreecommitdiff
path: root/keyboards/ianklug/grooveboard/readme.md
diff options
context:
space:
mode:
authorZach White <skullydazed@gmail.com>2021-07-14 10:30:28 -0700
committerZach White <skullydazed@gmail.com>2021-07-14 10:30:28 -0700
commit44d322623eb875f6eb2e0a317c76af2d47f7a9dc (patch)
treeab722bcc4cea4e4ed16f0a5dce0602fe1f2c63e5 /keyboards/ianklug/grooveboard/readme.md
parent52cfc9259b58a3a11a244fbe35c49c7dd1a9cae0 (diff)
parentffdfe3798bc7bd374991abe8f10494f2e73aedd5 (diff)
Merge remote-tracking branch 'origin/master' into develop
Resolved Conflicts: keyboards/checkerboards/nop60/info.json
Diffstat (limited to 'keyboards/ianklug/grooveboard/readme.md')
-rw-r--r--keyboards/ianklug/grooveboard/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/ianklug/grooveboard/readme.md b/keyboards/ianklug/grooveboard/readme.md
new file mode 100644
index 0000000000..7ea6456e38
--- /dev/null
+++ b/keyboards/ianklug/grooveboard/readme.md
@@ -0,0 +1,21 @@
+# Grooveboard
+
+A four-key mechanical keyboard for rhythm games.
+
+![Grooveboard Choc PCB](https://i.imgur.com/wbMkbHX.jpg)
+
+* Keyboard Maintainer: [ianklug](https://github.com/ianklug)
+* Hardware Supported: grooveboard, grooveboard mx, grooveboard choc
+* Hardware Availability: https://github.com/ianklug/grooveboard
+
+Press the button on the back of the keyboard to enter bootloader mode.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ianklug/grooveboard:default
+
+Flashing example for this keyboard:
+
+ make ianklug/grooveboard: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).