[gnome-autoar/wip/oholy/readme: 1/2] Add README.md file




commit 7fe13c15fe8e1b21c2c8387a8494ea14f781ff52
Author: Ondrej Holy <oholy redhat com>
Date:   Wed Mar 24 10:56:48 2021 +0100

    Add README.md file
    
    Currently, there is no README file, so GitLab doesn't show any project
    info. Let's add one with some basic info. Also, update the corresponding
    texts in .doap and docs as they are slightly outdated and misleading.
    
    Fixes: https://gitlab.gnome.org/GNOME/gnome-autoar/-/issues/13

 README.md                            | 5 +++++
 docs/reference/gnome-autoar-docs.xml | 6 +++---
 gnome-autoar.doap                    | 4 ++--
 3 files changed, 10 insertions(+), 5 deletions(-)
---
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..712af06
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# gnome-autoar
+
+gnome-autoar is a GLib based library that provides archive handling
+functionality for GNOME applications. It provides APIs to create and extract
+archives and also simple GTK widgets.
diff --git a/docs/reference/gnome-autoar-docs.xml b/docs/reference/gnome-autoar-docs.xml
index a71c7e5..d501c30 100644
--- a/docs/reference/gnome-autoar-docs.xml
+++ b/docs/reference/gnome-autoar-docs.xml
@@ -8,9 +8,9 @@
   <bookinfo>
     <title>gnome-autoar Reference Manual</title>
     <releaseinfo>
-       gnome-autoar provides functions, widgets, and gschemas for GNOME
-       applications which want to use archives as a convenient method
-       to transfer directories over the internet.
+      gnome-autoar is a GLib based library that provides archive handling
+      functionality for GNOME applications. It provides APIs to create and
+      extract archives and also simple GTK widgets.
     </releaseinfo>
   </bookinfo>
 
diff --git a/gnome-autoar.doap b/gnome-autoar.doap
index 2c9295b..5428b28 100644
--- a/gnome-autoar.doap
+++ b/gnome-autoar.doap
@@ -5,8 +5,8 @@
          xmlns:gnome="http://api.gnome.org/doap-extensions#";
          xmlns="http://usefulinc.com/ns/doap#";>
   <name xml:lang="en">gnome-autoar</name>
-  <shortdesc xml:lang="en">Automatic archives creating and extracting library</shortdesc>
-  <description>gnome-autoar provides functions, widgets, and gschemas for GNOME applications which want to 
use archives as a method to transfer directories over the Internet.</description>
+  <shortdesc xml:lang="en">Archive handling library for GNOME</shortdesc>
+  <description>gnome-autoar is a GLib based library that provides archive handling functionality for GNOME 
applications. It provides APIs to create and extract archives and also simple GTK widgets.</description>
 
   <category rdf:resource="http://api.gnome.org/doap-extensions#apps"; />
   <programming-language>C</programming-language>


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