[libmanette] doc: Describe the library in the Overview chapter



commit b14feda5f77f4b8bbb1aff540e9ad329458bf5f1
Author: Adrien Plazas <kekun plazas laposte net>
Date:   Sun Nov 15 21:52:56 2020 +0100

    doc: Describe the library in the Overview chapter

 doc/manette-doc.xml | 46 +++++++++++++++++++++++++---------------------
 1 file changed, 25 insertions(+), 21 deletions(-)
---
diff --git a/doc/manette-doc.xml b/doc/manette-doc.xml
index 2f9a713..b5949df 100644
--- a/doc/manette-doc.xml
+++ b/doc/manette-doc.xml
@@ -15,27 +15,6 @@
         The latest version can be found online at
         <ulink role="online-location" 
url="https://gnome.pages.gitlab.gnome.org/libmanette/";>https://gnome.pages.gitlab.gnome.org/libmanette/</ulink>.
       </para>
-      <para>
-        <ulink type="http" url="&package_url;">libmanette</ulink> is a small
-        GObject library giving you simple access to game controllers.
-      </para>
-      <para>
-        This library is intended for software needing a painless access to game
-        controllers from any programming language and with little dependencies.
-      </para>
-      <para>
-        It supports the de-facto standard gamepads as defined by the
-        <ulink type="http" url="https://www.w3.org/TR/gamepad/";>W3C standard Gamepad specification</ulink>
-        or as implemented by the
-        <ulink type="http" url="https://wiki.libsdl.org/CategoryGameController";>SDL GameController</ulink>.
-        More game controller kinds could be supported in the future if needed.
-        Mapping of the devices is handled transparently and internally by the
-        library using the popular SDL mapping string format.
-      </para>
-      <para>
-        The API is inspired by the device and event handling of GDK, so anybody
-        used to GTK+ should feel right at home.
-      </para>
       <para>
         If you find any issues in this API reference, please report it using
         <ulink type="http" url="&package_bugreport;">the bugtracker</ulink>.
@@ -50,6 +29,31 @@
 
   <chapter id="overview">
     <title>libmanette Overview</title>
+
+    <para>
+      &package_name;, the simple GObject game controller library.
+    </para>
+
+    <para>
+      &package_name; offers painless access to game controllers, from any
+      programming language and with little dependencies.
+    </para>
+
+    <para>
+      It supports the de-facto standard gamepad, as defined by the
+      <ulink type="http" url="https://www.w3.org/TR/gamepad/";>W3C standard gamepad specification</ulink>
+      or as implemented by the
+      <ulink type="http" url="https://wiki.libsdl.org/CategoryGameController";>SDL GameController</ulink>.
+      Convertion of raw gamepad events into usable ones is handled transparently
+      using an embedded library of mappings in the popular SDL mapping string
+      format.
+    </para>
+
+    <para>
+      The API is inspired by the device and event handling of GDK, so anybody
+      used to <ulink type="http" url="https://gtk.org/";>GTK</ulink> should feel
+      right at home.
+    </para>
   </chapter>
 
   <chapter id="core-api">


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]