summaryrefslogtreecommitdiffstats
path: root/keyboards/obelus/readme.md
diff options
context:
space:
mode:
authorEthan Madden <maddene@madden.ninja>2017-06-08 22:24:37 +0200
committerJack Humbert <jack.humb@gmail.com>2017-09-26 01:36:44 +0200
commit692c4e7508e18d83baea230cdcaee28c3037df3b (patch)
tree381ef4ff08af2b1b21a87860e17ac33c0dc39e60 /keyboards/obelus/readme.md
parentf1c7b813aa7a09e2d3fdd46d373115d1e85f4c3e (diff)
downloadqmk_firmware-692c4e7508e18d83baea230cdcaee28c3037df3b.tar.gz
qmk_firmware-692c4e7508e18d83baea230cdcaee28c3037df3b.tar.xz
Added Obelus
tearing it down so that it can be rebuilt fiddling with audio big default config overhaul apparently startup sounds work without the override now readme! readme fixes readme tweaking
Diffstat (limited to 'keyboards/obelus/readme.md')
-rw-r--r--keyboards/obelus/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/obelus/readme.md b/keyboards/obelus/readme.md
new file mode 100644
index 000000000..e08ed44dd
--- /dev/null
+++ b/keyboards/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, /u/MonkeyPlusPlus
+
+Make example for this keyboard (after setting up your build environment):
+
+ make obelus-default
+
+Or to make and flash:
+
+ make 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.
+