Add preliminary ngIRCd protocol module for Anope 1.9

[ngircd-alex.git] / contrib / Anope / README

diff --git a/contrib/Anope/README b/contrib/Anope/README
new file mode 100644 (file)
index 0000000..ea47b06
--- /dev/null
+++ b/contrib/Anope/README
@@ -0,0 +1,36 @@
+
+                     ngIRCd - Next Generation IRC Server
+                           http://ngircd.barton.de/
+
+               (c)2001-2011 Alexander Barton and Contributors.
+               ngIRCd is free software and published under the
+                   terms of the GNU General Public License.
+
+                          -- contrib/Anope/README --
+
+
+This directory contains two preliminary patches that (re-) add a ngIRCd
+protocol module to the Anope 1.9 development branch. It has been tested
+with Anope 1.9.4, there is no guarantee that it will work with other
+versions as Anope 1.9.x is under heavy development ...
+
+To build this Anope protocol module, you have to
+
+ - Download the Anope 1.9.x sources (tested with 1.9.4),
+ - Patch in the ngIRCd protocol module,
+ - Build and install Anope as usual,
+ - Configure Anope as usual, use "ngircd" as protocol module.
+
+So the command sequence can be something like this:
+
+ $ tar xzf anope-1.9.4-source.tar.gz
+ $ cd anope-1.9.4-source
+ $ patch -p1 < .../ngircd/contrib/Anope/0001-Revert-Removed-ngircd.patch
+ $ patch -p1 < .../ngircd/contrib/Anope/0002-ngircd-whitespace-fixes.patch
+ $ ./Config
+ $ cd build
+ $ make
+ $ make install
+
+Please have a look at the file doc/Services.txt for more information about
+how to set up ngIRCd and Anope.