From 9a71ac8a910419f6810a170b4542e39057ef7ba4 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Mon, 8 Jan 2024 21:07:33 +0100 Subject: [PATCH] Update the project description, enhance & fix the README.md --- README.md | 34 +++++++++++++++------------ contrib/de.barton.ngircd.metainfo.xml | 4 ++-- 2 files changed, 21 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 61593186..66ec0418 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,14 @@ server for small or private networks, developed under the terms of the GNU General Public License ([GPL]); please see the file `COPYING` for licensing information. -The server is quite easy to configure, can handle dynamic IP addresses, and -optionally supports IDENT, IPv6 connections, SSL-protected links, and PAM for -user authentication as well as character set conversion for legacy clients. The -server has been written from scratch and is not based on the "forefather", the -daemon of the IRCNet. - -The name ngIRCd means *next-generation IRC daemon*, which is a little bit +The server is quite easy to configure and runs as a single-node server or can +be part of a network of ngIRCd servers in a LAN or across the internet. It +optionally supports the IPv6 protocol, SSL/TLS-protected client-server and +server-server links, the Pluggable Authentication Modules (PAM) system for user +authentication, IDENT requests, and character set conversion for legacy +clients. + +The name ngIRCd stands for *next-generation IRC daemon*, which is a little bit exaggerated: *lightweight Internet Relay Chat server* most probably would have been a better name :-) @@ -22,13 +23,16 @@ online available here: ! ## Status -The development of ngIRCd started back in 2001 and in the meantime it should be -quite feature-complete and stable to be used as a daemon in real-world IRC -networks. +Development of *ngIRCd* started back in 2001: The server has been written from +scratch in C, tries to follow all relevant standards, and is not based on the +forefather, the daemon of the IRCNet. It is not the goal of ngIRCd to implement all the nasty behaviors of the -original ircd, but to implement most of the useful commands and semantics -specified by the RFCs that are used by existing clients. +original `ircd` or corner-cases in the RFCs, but to implement most of the useful +commands and semantics that are used by existing clients. + +*ngIRCd* is used as the daemon in real-world in-house and public IRC networks +and included in the package repositories of various operating systems. ## Features (or: why use ngIRCd?) @@ -41,13 +45,13 @@ specified by the RFCs that are used by existing clients. - No problems with servers that have dynamic IP addresses. - Freely available, modern, portable and tidy C source. - Wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX, - IRIX, Linux, macOS, NetBSD, OpenBSD, Solaris, and Windows with Cygwin. + IRIX, Linux, macOS, NetBSD, OpenBSD, Solaris and Windows with WSL or Cygwin. ## Documentation The **homepage** of the ngIRCd project is . -Installation on ngIRCd is described in the file `INSTALL.md` in the source +Installation of ngIRCd is described in the file `INSTALL.md` in the source directory; please see the file `doc/QuickStart.md` in the `doc/` directory for some configuration examples. @@ -70,7 +74,7 @@ Please don't hesitate to contact us if you encounter problems: - On IRC: - Via the mailing list: -See for details. +See for details. If you find any bugs in ngIRCd (which most probably will be there ...), please report them to our issue tracker at GitHub: diff --git a/contrib/de.barton.ngircd.metainfo.xml b/contrib/de.barton.ngircd.metainfo.xml index de618c1b..15f6b478 100644 --- a/contrib/de.barton.ngircd.metainfo.xml +++ b/contrib/de.barton.ngircd.metainfo.xml @@ -9,8 +9,8 @@ alex@barton.de

ngIRCd is a free, portable and lightweight Internet Relay Chat server for small or private networks, developed under the GNU General Public License (GPL).

-

The server is quite easy to configure, can handle dynamic IP addresses, and optionally supports IDENT, IPv6 connections, SSL-protected links, and PAM for user authentication as well as character set conversion for legacy clients. The server has been written from scratch and is not based on the "forefather", the daemon of the IRCNet.

-

The name ngIRCd means next-generation IRC daemon, which is a little bit exaggerated: lightweight Internet Relay Chat server most probably would have been a better name :-)

+

The server is quite easy to configure and runs as a single-node server or can be part of a network of ngIRCd servers in a LAN or across the internet. It optionally supports the IPv6 protocol, SSL/TLS-protected client-server and server-server links, the Pluggable Authentication Modules (PAM) system for user authentication, IDENT requests, and character set conversion for legacy clients.

+

The name ngIRCd stands for next-generation IRC daemon, which is a little bit exaggerated: lightweight Internet Relay Chat server most probably would have been a better name :-)

 https://ngircd.barton.de/common/ngircd-300x300.png -- 2.39.2