Remove AUTHORS and add general information to README.md

kjellahl · kjellahl · commit 92dbe0bb5fc2 · 2023-07-09T16:52:16.000+02:00
Update the .doap file and rename it to libxmlplusplus.doap. See https://gitlab.gnome.org/GNOME/gtkmm/-/issues/140
diff --git a/AUTHORS b/AUTHORS
diff --git a/Makefile.am b/Makefile.am
@@ -18,7 +18,9 @@ nodist_pkgconfig_DATA = $(LIBXMLXX_MODULE_NAME).pc
 
 include $(srcdir)/MSVC_NMake/filelist.am
 
-dist_noinst_DATA = $(addprefix MSVC_NMake/,$(msvc_nmake_data))
+dist_noinst_DATA = \
+  $(addprefix MSVC_NMake/,$(msvc_nmake_data)) \
+  README.md
 
 dist_noinst_SCRIPTS = autogen.sh
 
diff --git a/README.md b/README.md
@@ -1,20 +1,54 @@
 # libxml++
+C++ interface to libxml2 and XML files.
+
+# Introduction
+
 libxml++ (a.k.a. libxmlplusplus) provides a C++ interface to XML files. It uses
 libxml2 to access the XML files, and in order to configure libxml++ you must
 have both libxml2 and pkg-config installed.
 
-To get the latest version of libxml++, see the
-[libxml++ web site](https://libxmlplusplus.github.io/libxmlplusplus/)
+libxml++-2.6, libxml++-3.0, libxml++-4.0 and libxml++-5.0 are different
+parallel-installable ABIs. This file describes libxml++-2.6.
 
 See the examples directory for example code.
 
-Use pkg-config to discover the necessary include and linker arguments. For instance,
+Use pkg-config to discover the necessary include and linker arguments.
+For instance,
 ```
   pkg-config libxml++-2.6 --cflags --libs
 ```
 If you build with Autotools, ideally you would use PKG_CHECK_MODULES in your
 configure.ac file.
 
+# General information
+
+Web site
+ - https://libxmlplusplus.github.io/libxmlplusplus/
+
+Download location
+ - https://download.gnome.org/sources/libxml++/
+ - https://github.com/libxmlplusplus/libxmlplusplus/releases/
+
+Reference documentation
+ - https://developer-old.gnome.org/libxml++/2.42/
+
+This reference documentation does not document the latest release. If you want
+newer documentation, download a tarball. Tarballs contain reference documentation.
+In tarballs generated with Meson, see the untracked/docs/reference/html directory.
+
+Discussion on GNOME's discourse forum
+ - https://discourse.gnome.org/tag/cplusplus
+ - https://discourse.gnome.org/c/platform
+
+Git repository
+ - https://github.com/libxmlplusplus/libxmlplusplus
+
+Bugs can be reported to
+ - https://github.com/libxmlplusplus/libxmlplusplus/issues
+
+Patches can be submitted to
+ - https://github.com/libxmlplusplus/libxmlplusplus/pulls
+
 # Building
 
 Whenever possible, you should use the official binary packages approved by the
diff --git a/configure.ac b/configure.ac
@@ -10,7 +10,7 @@ AC_CONFIG_AUX_DIR([build])
 AC_CONFIG_MACRO_DIR([build])
 AC_CONFIG_HEADERS([config.h libxml++config.h])
 
-AM_INIT_AUTOMAKE([1.9 -Wno-portability dist-bzip2 no-define nostdinc subdir-objects])
+AM_INIT_AUTOMAKE([1.9 -Wno-portability dist-bzip2 no-define nostdinc subdir-objects foreign])
 # Support silent build rules.
 # Disable by either passing --disable-silent-rules to configure or passing V=1 to make.
 m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
diff --git a/libxmlplusplus.doap b/libxmlplusplus.doap
@@ -1,21 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <Project xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
          xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
          xmlns:foaf="http://xmlns.com/foaf/0.1/"
          xmlns:gnome="http://api.gnome.org/doap-extensions#"
          xmlns="http://usefulinc.com/ns/doap#">
 
-  <name xml:lang="en">libxml++</name>
+  <!-- A .doap file (Description of a Project) is not necessary on GitHub.
+       It's retained in case libxml++ is ever moved back to gnome.org.
+  -->
+  <name xml:lang="en">libxmlplusplus</name>
   <shortdesc xml:lang="en">C++ bindings for libxml2</shortdesc>
-  <description>libxml++ is a C++ wrapper for the libxml2 XML parser library.
+  <description xml:lang="en">
+libxmlplusplus (aka libxml++) is a C++ wrapper for the libxml2 XML parser library.
 It has SAX and DOM-like APIs, but does not attempt to conform exactly to
-the DOM specification. Its API is simpler than the underlying libxml2 C API.</description>
+the DOM specification. Its API is simpler than the underlying libxml2 C API.
+  </description>
   <homepage rdf:resource="https://libxmlplusplus.github.io/libxmlplusplus/" />
-  <mailing-list rdf:resource="mailto:libxmlplusplus-list@gnome.org" />
+  <developer-forum rdf:resource="https://discourse.gnome.org/tag/cplusplus/" />
   <download-page rdf:resource="https://download.gnome.org/sources/libxml++/" />
+  <download-page rdf:resource="https://github.com/libxmlplusplus/libxmlplusplus/releases/" />
   <bug-database rdf:resource="https://github.com/libxmlplusplus/libxmlplusplus/issues" />
-  <!-- Don't know which category to use. See https://mail.gnome.org/archives/desktop-devel-list/2014-August/msg00106.html
   <category rdf:resource="http://api.gnome.org/doap-extensions#bindings" />
-  -->
   <programming-language>C++</programming-language>
 
   <maintainer>
@@ -27,9 +32,9 @@ the DOM specification. Its API is simpler than the underlying libxml2 C API.</de
   </maintainer>
   <maintainer>
     <foaf:Person>
-      <foaf:name>Christophe de Vienne</foaf:name>
-      <foaf:mbox rdf:resource="mailto:cdevienn@src.gnome.org" />
-      <gnome:userid>cdevienn</gnome:userid>
+      <foaf:name>Kjell Ahlstedt</foaf:name>
+      <foaf:mbox rdf:resource="mailto:kjellahlstedt@gmail.com" />
+      <gnome:userid>kjellahl</gnome:userid>
     </foaf:Person>
   </maintainer>
 </Project>
