[devhelp] Improve long description

[Sébastien Wilmet <swilmet src gnome org>]

commit e81139b6e612b0b1cda1452c4f40def3e8b7762a
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Thu Dec 21 22:23:24 2017 +0100

    Improve long description
    
    There was a different description a bit everywhere:
    - the README
    - the *.doap
    - the AppData
    - the wiki
    
    This commit tries to have the same long description everywhere, and to
    improve it.

 README                                |   48 ++++++++++++++++++++++----------
 data/org.gnome.Devhelp.appdata.xml.in |   19 ++++++++++---
 devhelp.doap                          |   14 +++++++++
 3 files changed, 62 insertions(+), 19 deletions(-)
---
diff --git a/README b/README
index 8b80b17..639096e 100644
--- a/README
+++ b/README
@@ -1,28 +1,46 @@
-Devhelp information
-===================
+Devhelp
+=======
 
 The Devhelp web page:
 
-  https://wiki.gnome.org/Apps/Devhelp
+    https://wiki.gnome.org/Apps/Devhelp
+
+Dependencies
+------------
 
-Dependencies:
 - glib >= 2.38
 - gtk+ >= 3.22
 - webkit2gtk-4.0 >= 2.19.2
 - gsettings-desktop-schemas
 
+Description
+-----------
+
 Devhelp is a developer tool for browsing and searching API documentation.
+It provides an easy way to navigate through libraries and to search by
+function, struct, or macro.
+
+The documentation must be installed locally, so an internet connection is
+not needed to use Devhelp.
+
+Devhelp works natively with GTK-Doc, so the GTK+ and GNOME libraries are
+well supported. But other development platforms can be supported as well,
+as long as the API documentation is available in HTML and a *.devhelp2
+index file is generated.
+
+Devhelp integrates with other applications such as Glade, Builder or
+Anjuta, and plugins are available for different text editors (gedit, Vim,
+Emacs, Geany, …).
 
-Its primary goal is to well support GTK+ and GNOME libraries, but other
-development platforms can be supported, as long as the API documentation is
-available in HTML and a *.devhelp2 index file is generated.
+How it works
+------------
 
 When you build (or install) a GNOME library, GTK-Doc will build an API
 reference for you and install it into:
 
-  $datadir/gtk-doc/html/$PACKAGE. 
+  $datadir/gtk-doc/html/$PACKAGE/
 
-Along with the HTML files, a .devhelp and/or .devhelp2 index file is
+Along with the HTML files, a *.devhelp and/or *.devhelp2 index file is
 also generated automatically. Thus Devhelp can simply scan that folder
 for those index files and display the books they represent.
 
@@ -34,20 +52,20 @@ documentation. You can read more about that specification here:
 The list of locations searched for devhelp books is:
 
 $XDG_DATA_HOME/devhelp/books
-   e.g. /home/ross/.local/share/devhelp/books/glib-2.0/glib-2.0.devhelp
+   e.g. /home/ross/.local/share/devhelp/books/glib-2.0/glib-2.0.devhelp2
 
 $XDG_DATA_HOME/gtk-doc/html
-   e.g. /home/ross/.local/share/gtk-doc/html/glib-2.0/glib-2.0.devhelp
+   e.g. /home/ross/.local/share/gtk-doc/html/glib-2.0/glib-2.0.devhelp2
 
 $XDG_DATA_DIRS/devhelp/books
-   e.g. /usr/local/share/devhelp/books/glib-2.0/glib-2.0.devhelp
+   e.g. /usr/local/share/devhelp/books/glib-2.0/glib-2.0.devhelp2
 
 $XDG_DATA_DIRS/gtk-doc/html
-   e.g. /usr/local/share/gtk-doc/html/glib-2.0/glib-2.0.devhelp
+   e.g. /usr/local/share/gtk-doc/html/glib-2.0/glib-2.0.devhelp2
 
 Note that the two latter consist of :-separated lists of directories to
 look for. Those environment variables are normally set up by the
 desktop environment or distribution.
 
-Note that the name of the directory the .devhelp file is in and the
-name of the .devhelp file (minus the extension) must match.
+Note that the name of the directory the *.devhelp2 file is in and the
+name of the *.devhelp2 file (minus the extension) must match.
diff --git a/data/org.gnome.Devhelp.appdata.xml.in b/data/org.gnome.Devhelp.appdata.xml.in
index 92eb556..c7e3cbd 100644
--- a/data/org.gnome.Devhelp.appdata.xml.in
+++ b/data/org.gnome.Devhelp.appdata.xml.in
@@ -8,12 +8,23 @@
   <description>
     <p>
       Devhelp is a developer tool for browsing and searching API documentation.
-      It provides an easy way to navigate through libraries, search by function,
-      struct, or macro.
-      It provides a tabbed interface and allows to print results.
+      It provides an easy way to navigate through libraries and to search by
+      function, struct, or macro.
     </p>
     <p>
-      Devhelp integrates with other applications such as Glade, Anjuta, or Geany.
+      The documentation must be installed locally, so an internet connection is
+      not needed to use Devhelp.
+    </p>
+    <p>
+      Devhelp works natively with GTK-Doc, so the GTK+ and GNOME libraries are
+      well supported. But other development platforms can be supported as well,
+      as long as the API documentation is available in HTML and a *.devhelp2
+      index file is generated.
+    </p>
+    <p>
+      Devhelp integrates with other applications such as Glade, Builder or
+      Anjuta, and plugins are available for different text editors (gedit, Vim,
+      Emacs, Geany, …).
     </p>
   </description>
   <url type="homepage">https://wiki.gnome.org/Apps/Devhelp/</url>
diff --git a/devhelp.doap b/devhelp.doap
index 17a5a2f..4f9557f 100644
--- a/devhelp.doap
+++ b/devhelp.doap
@@ -9,6 +9,20 @@
   <shortdesc xml:lang="en">A developer tool for browsing and searching API documentation</shortdesc>
   <description xml:lang="en">
 Devhelp is a developer tool for browsing and searching API documentation.
+It provides an easy way to navigate through libraries and to search by
+function, struct, or macro.
+
+The documentation must be installed locally, so an internet connection is
+not needed to use Devhelp.
+
+Devhelp works natively with GTK-Doc, so the GTK+ and GNOME libraries are
+well supported. But other development platforms can be supported as well,
+as long as the API documentation is available in HTML and a *.devhelp2
+index file is generated.
+
+Devhelp integrates with other applications such as Glade, Builder or
+Anjuta, and plugins are available for different text editors (gedit, Vim,
+Emacs, Geany, …).
   </description>
 
   <homepage rdf:resource="https://wiki.gnome.org/Apps/Devhelp"; />