summaryrefslogtreecommitdiffstats
path: root/docs/hardware_drivers.md
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2017-10-25 05:34:28 +0200
committerGitHub <noreply@github.com>2017-10-25 05:34:28 +0200
commit67cc5cebc0430d15169e2c649ea25112a31bfa31 (patch)
treef90f432a40b1d03ec7b9e68666c2444f2b2d0e79 /docs/hardware_drivers.md
parent8892c50336fe49fbd3524ed44f2139074dca5ba6 (diff)
downloadqmk_firmware-67cc5cebc0430d15169e2c649ea25112a31bfa31.tar.gz
qmk_firmware-67cc5cebc0430d15169e2c649ea25112a31bfa31.tar.xz
Restructure the hardware and feature docs to make things easier to find (#1888)
* fix #1313 by documenting more config.h options * Clean up and organize documentation
Diffstat (limited to 'docs/hardware_drivers.md')
-rw-r--r--docs/hardware_drivers.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/hardware_drivers.md b/docs/hardware_drivers.md
new file mode 100644
index 000000000..a298a8dc3
--- /dev/null
+++ b/docs/hardware_drivers.md
@@ -0,0 +1,27 @@
+# QMK Hardware Drivers
+
+QMK is used on a lot of different hardware. While support for the most common MCU's and matrix configurations is built-in there are a number of drivers that can be added to a keyboard to support additional hardware. Examples include mice and other pointing devices, i/o expanders for split keyboards, bluetooth modules, and LCD, OLED, and TFT screens.
+
+<!-- FIXME: This should talk about how drivers are integrated into QMK and how you can add your own driver.
+
+# Driver System Overview
+
+-->
+
+# Available Drivers
+
+## ProMicro (AVR only)
+
+Support for addressing pins on the ProMicro by their Arduino name rather than their AVR name. This needs to be better documented, if you are trying to do this and reading the code doesn't help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) and we can help you through the process.
+
+## SSD1306 (AVR only)
+
+Support for SSD1306 based OLED displays. This needs to be better documented, if you are trying to do this and reading the code doesn't help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) and we can help you through the process.
+
+## uGFX
+
+You can make use of uGFX within QMK to drive character and graphic LCD's, LED arrays, OLED, TFT, and other display technologies. This needs to be better documented, if you are trying to do this and reading the code doesn't help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) and we can help you through the process.
+
+## WS2812 (AVR only)
+
+Support for WS2811/WS2812{a,b,c} LED's. For more information see the [RGB Light](feature_rgblight.md) page.