Remove AUTHORS and add general information to README.md

kjellahl · kjellahl · commit 5c9d60c70ebd · 2023-07-06T15:59:46.000+02:00
See https://gitlab.gnome.org/GNOME/gtkmm/-/issues/140
diff --git a/AUTHORS b/AUTHORS
diff --git a/README.md b/README.md
@@ -1,10 +1,11 @@
-# libsigc++ : The Typesafe Callback Framework for C++
+# libsigc++
+Typesafe Callback Framework for C++
 
-## Introduction
+# Introduction
 
-libsigc++ implements a typesafe callback system for standard C++. It
-allows you to define signals and to connect those signals to any
-callback function, either global or a member function, regardless of
+libsigc++ (a.k.a. libsigcplusplus) implements a typesafe callback system for
+standard C++. It allows you to define signals and to connect those signals
+to any callback function, either global or a member function, regardless of
 whether it is static or virtual.
 
 libsigc++ is used by gtkmm to wrap the GTK signal system. It does not
@@ -13,8 +14,6 @@ depend on GTK or gtkmm.
 sigc++-2.0 and sigc++-3.0 are different parallel-installable ABIs.
 This file describes sigc++-3.0.
 
-See the [libsigc++ web site](https://libsigcplusplus.github.io/libsigcplusplus/)
-
 ## License
 
 Distribution of library and components is under the LGPL as listed in the
@@ -25,7 +24,35 @@ file COPYING. Examples and tests are Public Domain.
 Compatible compilers must support C++17, such as the decltype(auto) specifier
 (from C++14) and std::invoke().
 
-## Build
+# General information
+
+Web site
+ - https://libsigcplusplus.github.io/libsigcplusplus/
+
+Download location
+ - https://download.gnome.org/sources/libsigc++/
+ - https://github.com/libsigcplusplus/libsigcplusplus/releases/
+
+Reference documentation
+ - https://libsigcplusplus.github.io/libsigcplusplus/reference/html/
+
+Tarballs contain reference documentation. In tarballs generated with Meson,
+see the untracked/docs/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/libsigcplusplus/libsigcplusplus
+
+Bugs can be reported to
+ - https://github.com/libsigcplusplus/libsigcplusplus/issues
+
+Patches can be submitted to
+ - https://github.com/libsigcplusplus/libsigcplusplus/pulls
+
+# Building
 
 Whenever possible, you should use the official binary packages approved by the
 supplier of your operating system, such as your Linux distribution. For
@@ -34,8 +61,7 @@ packages.
 
 ## Building from a release tarball
 
-Building from the [libsigc++ release tarball](https://github.com/libsigcplusplus/libsigcplusplus/releases)
-is easier than building from git.
+Building from a release tarball is easier than building from git.
 
 It's easiest to build with Meson, if the tarball was made with Meson,
 and to build with Autotools, if the tarball was made with Autotools.
@@ -148,4 +174,4 @@ $ make
 
 ## Building with Microsoft Visual C++
 
-See MSVC_NMake/MSVC-Builds.md.
+See [MSVC-Builds.md](MSVC_NMake/MSVC-Builds.md)
diff --git a/libsigcplusplus.doap b/libsigcplusplus.doap
@@ -1,23 +1,30 @@
+<?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#">
 
+  <!-- A .doap file (Description of a Project) is not necessary on GitHub.
+       It's retained in case libsigc++ is ever moved back to gnome.org.
+  -->
   <name xml:lang="en">libsigc++</name>
   <shortdesc xml:lang="en">Typesafe callback framework for C++</shortdesc>
-  <description>libsigc++ implements a typesafe callback system for standard C++.
+  <description xml:lang="en">
+libsigc++ implements a typesafe callback system for standard C++.
 It allows you to define signals and to connect those signals to any
 callback function, either global or a member function, regardless of
 whether it is static or virtual.
 
-libsigc++ is also used by glibmm and gtkmm to wrap Glib and GTK+ signals.</description>
+libsigc++ is also used by glibmm and gtkmm to wrap GLib and GTK signals.
+  </description>
   <homepage rdf:resource="https://libsigcplusplus.github.io/libsigcplusplus/" />
+  <developer-forum rdf:resource="https://discourse.gnome.org/tag/cplusplus/" />
+  <download-page rdf:resource="https://download.gnome.org/sources/libsigc++/" />
+  <download-page rdf:resource="https://github.com/libsigcplusplus/libsigcplusplus/releases/" />
   <bug-database rdf:resource="https://github.com/libsigcplusplus/libsigcplusplus/issues/" />
-  <mailing-list rdf:resource="mailto:libsigc-list@gnome.org" />
   <category rdf:resource="http://api.gnome.org/doap-extensions#core" />
   <programming-language>C++</programming-language>
-  <download-page rdf:resource="http://download.gnome.org/sources/libsigc++/" />
 
   <maintainer>
     <foaf:Person>
