]> arthur.barton.de Git - ngircd-web.git/commitdiff
Add a README.md file ...
authorAlexander Barton <alex@barton.de>
Sat, 23 Mar 2024 19:41:08 +0000 (20:41 +0100)
committerAlexander Barton <alex@barton.de>
Sat, 23 Mar 2024 19:44:48 +0000 (20:44 +0100)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..70262d4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# ngIRCd Homepage
+
+This is the *homepage* of ngIRCd, a free, portable and lightweight Internet
+Relay Chat (IRC) server for small or private networks.
+
+The homepage itself can be found on <https://ngircd.barton.de>.
+
+This source code is available on
+[GitHub](https://github.com/ngircd/ngircd-web).
+
+## Building the Manual Pages
+
+Use `pandoc` like this:
+
+```bash
+pandoc -s -f man -t html -o ngircd.conf.5.html ../ngIRCd.git/man/ngircd.conf.5
+pandoc -s -f man -t html -o man/ngircd.8.html ../ngIRCd.git/man/ngircd.8
+```
+
+Don't forget to add the updates HTML files to the Git repository!