Convert contrib/README to Markdown

diff --git a/contrib/Makefile.am b/contrib/Makefile.am
index c42c922139bb6f8f0a9bdba151dbf60a88aa61ab..27731b3f8aa1feec45d0b9bbfabbe2f6bd4422ec 100644 (file)
--- a/contrib/Makefile.am
+++ b/contrib/Makefile.am
@@ -11,7 +11,7 @@
 
 SUBDIRS = Debian
 
-EXTRA_DIST = README \
+EXTRA_DIST = README.md \
        de.barton.ngircd.metainfo.xml \
        de.barton.ngircd.plist \
        ngindent.sh \

diff --git a/contrib/README b/contrib/README
deleted file mode 100644 (file)
index b916d52..0000000
--- a/contrib/README
+++ /dev/null
@@ -1,48 +0,0 @@
-
-                     ngIRCd - Next Generation IRC Server
-                           http://ngircd.barton.de/
-
-               (c)2001-2024 Alexander Barton and Contributors.
-               ngIRCd is free software and published under the
-                   terms of the GNU General Public License.
-
-                             -- Contributions --
-
-
-Debian/
- - Various files for building Debian GNU/Linux packages (".deb's").
-       - ngircd.init; ngircd.default: init script for Debian-based systems.
-       - ngircd.pam: example PAM configuration.
-
-de.barton.ngircd.metainfo.xml
- - AppStream metadata file.
-
-de.barton.ngircd.plist[.tmpl]
- - launchd(8) property list file.
-
-ngindent.sh
- - Script to indent the code of ngIRCd in the "standard way".
-
-ngircd-bsd.sh
- - Start script for FreeBSD.
-
-ngircd-redhat.init
- - Start/stop script for RedHat-based distributions (like CentOS).
-
-ngircd.logcheck
- - Sample rules for logcheck(8) to ignore "normal" log messages of ngIRCd.
-
-ngircd.service
- - systemd(8) service unit configuration file.
-
-ngircd.socket
- - systemd(8) socket unit configuration file for "socket activation".
-
-ngircd.spec
- - RPM "spec" file.
-
-nglog.sh
- - Colorizes the log messages of ngircd(8) according to their log level.
-
-platformtest.sh
- - Build ngIRCd and output a "result line" suitable for doc/Platforms.txt.

diff --git a/contrib/README.md b/contrib/README.md
new file mode 100644 (file)
index 0000000..4f04dce
--- /dev/null
+++ b/contrib/README.md
@@ -0,0 +1,35 @@
+# [ngIRCd](https://ngircd.barton.de) - Supplemental Files
+
+This `contrib/` directory contains the following sub-folders and files:
+
+- `Debian/` folder: This subfolder contains the _rules_ file and additional
+  assets for building Debian packages.
+
+- `de.barton.ngircd.metainfo.xml`: AppStream metadata file.
+
+- `de.barton.ngircd.plist[.tmpl]`: launchd(8) property list file.
+
+- `ngindent.sh`: Script to indent the code of ngIRCd in the "standard way".
+
+- `ngircd-bsd.sh`: Start/stop script for FreeBSD.
+
+- `ngircd-redhat.init`: Start/stop script for old(er) RedHat-based
+  distributions (like CentOS and Fedora), which did _not_ use systemd(8).
+
+- `ngIRCd-Logo.gif`: The ngIRCd logo as GIF file.
+
+- `ngircd.logcheck`: Sample rules for logcheck(8) to ignore "normal" log
+  messages of ngIRCd.
+
+- `ngircd.service`: systemd(8) service unit configuration file.
+
+- `ngircd.socket`: systemd(8) socket unit configuration file for "socket
+  activation".
+
+- `ngircd.spec`: RPM "spec" file.
+
+- `nglog.sh`: Script for colorizing the log messages of ngircd(8) according to
+  their log level. Example: `./src/ngircd/ngircd -n | ./contrib/nglog.sh`.
+
+- `platformtest.sh`: Build ngIRCd and output a "result line" suitable for
+  the `doc/Platforms.txt` file.