aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/ckeys/obelus/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ckeys/obelus/readme.md')
-rw-r--r--keyboards/ckeys/obelus/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/ckeys/obelus/readme.md b/keyboards/ckeys/obelus/readme.md
new file mode 100644
index 000000000..6767956bf
--- /dev/null
+++ b/keyboards/ckeys/obelus/readme.md
@@ -0,0 +1,19 @@
+Obelus
+===
+
+[The Obelus](https://imgur.com/a/vj4LF) is designed to provide an easy platform to work with for people who are new to building keyboards. It is also especially useful as a QMK testbed, featuring support for a lot of the interesting features of QMK including audio, and a lot of spare pins broken out to headers for hacking away.
+
+Keyboard Maintaintainers: [Ethan Madden](https://github.com/jetpacktuxedo), [James Underwood](https://github.com/ju0)
+Hardware Supported: Obelus
+Hardware Availability: [C-Keys soldering workshops](https://ckeys.org/workshops/), [/u/MonkeyPlusPlus](https://www.reddit.com/user/monkeyplusplus)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ckeys/obelus:default
+
+Or to make and flash:
+
+ make ckeys/obelus:default:dfu
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) and [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+