aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2022-07-30 17:11:29 +0200
committerMattias Andrée <maandree@kth.se>2022-07-30 17:11:29 +0200
commitfb4f6aaa779b4f4ff5dea511492f6c95c8eda572 (patch)
treec751f9a7b1217a7a86b0101591434808a8ba651f
parentMinor improvements (diff)
downloadlibgamepad-fb4f6aaa779b4f4ff5dea511492f6c95c8eda572.tar.gz
libgamepad-fb4f6aaa779b4f4ff5dea511492f6c95c8eda572.tar.bz2
libgamepad-fb4f6aaa779b4f4ff5dea511492f6c95c8eda572.tar.xz
Add readme
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--README24
-rw-r--r--TODO1
2 files changed, 24 insertions, 1 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b2ce85e
--- /dev/null
+++ b/README
@@ -0,0 +1,24 @@
+NAME
+ libgamepad - Game controller library
+
+DESCRIPTION
+ libgamepad is a C library that implements game controller
+ support. libgamepad implements not only reading input and
+ applying force feedback, but also provides controller
+ information such as layout details, canoncial button names,
+ button icons, button colours, and conformity to well known
+ controller schemes, and applies fixes such as remapping buttons
+ and axes, and removing non-existent ones, correct axes
+ information, and apply calibrations, it even lets you
+ implement userspace drivers (however input reading only) if
+ kernel drivers are missing or lacking, as long as a hidraw
+ input device is available.
+
+ Games for video gaming consoles know in advance how the
+ game controller is supposed to look for the platform it is
+ running on, but on PCs it does not have any information,
+ and can therefore not display an image of your controller,
+ tell you the names or colours, or display icons, for which
+ buttons to press. libgamepad aims to solve this, and make
+ controllers appears almost as native to PCs as to video
+ gaming consoles.
diff --git a/TODO b/TODO
index c82bd57..0a64a3b 100644
--- a/TODO
+++ b/TODO
@@ -4,6 +4,5 @@ Add support for quirks
Add support for leds
Add support for accelerometer and gyroscope
Add man pages
-Add readme file
Add force feedback tests
Fix error details in .h documentation