Move ckeys workshop to its own directory (#2928)

[qmk_firmware.git] / keyboards / ckeys / obelus / readme.md

diff --git a/keyboards/ckeys/obelus/readme.md b/keyboards/ckeys/obelus/readme.md
new file mode 100644 (file)
index 0000000..6767956
--- /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.
+