summaryrefslogtreecommitdiffstats
path: root/docs/feature_pointing_device.md
diff options
context:
space:
mode:
authorDasky <32983009+daskygit@users.noreply.github.com>2022-02-05 14:29:15 +0000
committerGitHub <noreply@github.com>2022-02-05 14:29:15 +0000
commitb1debfb12f76759e96619c98116c9c59617c727a (patch)
tree8f21590009ab2c546fb4457220848322ff9cd4c8 /docs/feature_pointing_device.md
parent065f6eeb4e38748f685a99cfdbf6076694bd15ff (diff)
Remove default pointing device driver. (#16190)
* remove custom as default * add missing pointing_device_driver to rules.mk * Update docs
Diffstat (limited to 'docs/feature_pointing_device.md')
-rw-r--r--docs/feature_pointing_device.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/feature_pointing_device.md b/docs/feature_pointing_device.md
index 1972406ff7..4b39599f8a 100644
--- a/docs/feature_pointing_device.md
+++ b/docs/feature_pointing_device.md
@@ -2,7 +2,7 @@
Pointing Device is a generic name for a feature intended to be generic: moving the system pointer around. There are certainly other options for it - like mousekeys - but this aims to be easily modifiable and hardware driven. You can implement custom keys to control functionality, or you can gather information from other peripherals and insert it directly here - let QMK handle the processing for you.
-To enable Pointing Device, uncomment the following line in your rules.mk:
+To enable Pointing Device, add the following line in your rules.mk and specify one of the driver options below.
```make
POINTING_DEVICE_ENABLE = yes
@@ -181,7 +181,13 @@ The CPI range is 50-16000, in increments of 50. Defaults to 2000 CPI.
### Custom Driver
-If you have a sensor type that isn't supported here, you can manually implement it, by adding these functions (with the correct implementation for your device):
+If you have a sensor type that isn't supported above, a custom option is available by adding the following to your `rules.mk`
+
+```make
+POINTING_DEVICE_DRIVER = custom
+```
+
+Using the custom driver will require implementing the following functions:
```c
void pointing_device_driver_init(void) {}