summaryrefslogtreecommitdiff
path: root/keyboards/handwired/aball/readme.md
diff options
context:
space:
mode:
authorRichard <rich@brickbots.com>2022-01-07 19:22:35 -0800
committerGitHub <noreply@github.com>2022-01-07 19:22:35 -0800
commita2ed670eee98cab826e0b959576716cd7e13a946 (patch)
tree15508d5a668d620d77e1dc7d9d7c9417adf2559c /keyboards/handwired/aball/readme.md
parent4ace960b98bf50468cf560a50ce591d6de00639d (diff)
Add a-ball handwired trackball based on ADSN9800 (#9015)
* Initial commit of kball * Pretty much working * Rename to aball * Cleanup * Fix typo and make instructions * Refactor to use qmk spi * Suggestions from ZVECR * Update keyboards/handwired/aball/adns9800_srom_A6.h * Update keyboards/handwired/aball/adns.c * Update keyboards/handwired/aball/adns.c * Update keyboards/handwired/aball/adns.c * Added copyright and source attribution * Update keyboards/handwired/aball/rules.mk Include as quantum lib to help avoid timing issues with LTO * Only send report on change, adj sensitivity, fix src include * Fix issue causing constant reports and bad clamping * Streamline conversion to int, add required wait before burst read * Changes to track develop * Update rules with new feature descriptors, add info.json * Add stub layout * Rework / cleanup key matrix. Add missing CS pin define for new ADNS driver * Add stub keymap to enable compile
Diffstat (limited to 'keyboards/handwired/aball/readme.md')
-rw-r--r--keyboards/handwired/aball/readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/keyboards/handwired/aball/readme.md b/keyboards/handwired/aball/readme.md
new file mode 100644
index 0000000000..96a62d8386
--- /dev/null
+++ b/keyboards/handwired/aball/readme.md
@@ -0,0 +1,14 @@
+# ABall
+
+Your keyboard has plenty of buttons, why do you need more on your pointing device? ABall is a buttonless trackball designed to
+fit nicely next to a kyria, or other keyboard which serves as the mouse buttons. For my use I have left, middle and right mouse
+buttons on a layer along with keys for scroll up and down which I operate with my left hand while my right hand uses the ball for pointing.
+
+* Keyboard Maintainer: [Richard Sutherland](https://github.com/brickbots)
+* Special thanks to the Oddball for doing the heavy lifing with ADNS suport: [atulloh.github.io/oddball](https://atulloh.github.io/oddball)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/aball: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).