aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a2ec2c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+Qt Gamepad
+
+A Qt 5 module that adds support for getting events from gamepad devices on multiple platforms.
+
+Currently supports Linux (evdev), Windows (xinput) and OS X (via SDL2).
+
+This module provides classes that can:
+ - Read input events from game controllers (Button and Axis events), both from C++ and Qt Quick (QML)
+ - Provide a queryable input state (by processing events)
+ - Provide key bindings