summaryrefslogtreecommitdiff
path: root/keyboards/oddball/readme.md
diff options
context:
space:
mode:
authorAlexander Tulloh <alexandertulloh@gmail.com>2020-03-11 18:56:05 +1100
committerGitHub <noreply@github.com>2020-03-11 00:56:05 -0700
commite72562fe6fe3f3669559f88ba11d1074ad0e4ffa (patch)
tree9152103ede7d3b414f501eb286087a40e04aeddb /keyboards/oddball/readme.md
parent2b66acf04a82bc571ac5f545be7c43af722d6704 (diff)
downloadqmk_firmware-e72562fe6fe3f3669559f88ba11d1074ad0e4ffa.tar.gz
qmk_firmware-e72562fe6fe3f3669559f88ba11d1074ad0e4ffa.zip
[Keyboard] Oddball keyboard (#8352)
* Initial commit of oddball keyboard * Update oddball project url * Update pointer functions to only run on master side * Add unique product version * Capitalise product name * Convert oddball keymap layer flags to enum * Remove commented keyboard boilerplate code * Remove unused keymap config * Fix incorrect layout in info.json * Add markdown link text in readme
Diffstat (limited to 'keyboards/oddball/readme.md')
-rw-r--r--keyboards/oddball/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/oddball/readme.md b/keyboards/oddball/readme.md
new file mode 100644
index 0000000000..3f4a4a1b23
--- /dev/null
+++ b/keyboards/oddball/readme.md
@@ -0,0 +1,13 @@
+# Oddball
+
+A split keyboard with trackball support.
+
+* Keyboard Maintainer: [Alexander Tulloh](https://github.com/atulloh)
+* Hardware Supported: Oddball PCB and plates, and using an [ADNS9800 and breakout board for mouse](https://www.tindie.com/products/jkicklighter/adns-9800-laser-motion-sensor/)
+* Hardware Availability: [atulloh.github.io/oddball](https://atulloh.github.io/oddball)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make oddball:default
+
+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).