qmk-firmware/keyboards/oddball/readme.md
Alexander Tulloh ffd8ff642d
[Keyboard] Oddball keyboard and optical sensor update (#10450)
* Add oddballl v2

- add CPI options
- add scroll support
- add click-and-drag support
- PMW3360 implementation
- ADNS9800 improvements

* Set default make directory

* Update readme with PMW config

* Change bootloader

* Update unused pins on v2

* Remove diode switch

* Move bootloader selection to keyboard version level

* Change default keyboard folder to v1

* Move sensor selection to keymap

* Remove PK debounce

* Change to only send mouse report on change

* Change CPI function cpi type

* Remove EEPROM state check

* Update CPI to only change on key down

* Fix incorrect F8 in keymap

* Add v2.1 with more convenient controller pinout

* Add keyboard readmes

* Update keyboards/oddball/pmw/pmw3360_srom_0x04.h

Remove direct AVR reference

Co-authored-by: Ryan <fauxpark@gmail.com>

* Remove direct AVR reference

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: Alexander Tulloh <alex@riberry.io>
Co-authored-by: Ryan <fauxpark@gmail.com>
2021-01-10 19:13:47 -08:00

21 lines
917 B
Markdown

# 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](https://www.tindie.com/products/jkicklighter/adns-9800-laser-motion-sensor/) or a [PMW3360](https://www.tindie.com/products/jkicklighter/pmw3360-motion-sensor/) breakout board for mouse
* Hardware Availability: [atulloh.github.io/oddball](https://atulloh.github.io/oddball)
Make examples for this keyboard (after setting up your build environment):
```
# with ADNS sensor
make oddball/v2:default
```
```
# with PMW sensor
make oddball/v2:pmw3360
```
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).