Add doc/Contributing.txt to distribution archive

[ngircd-alex.git] / doc / README-Interix.txt

diff --git a/doc/README-Interix.txt b/doc/README-Interix.txt
index 8f5451f1551101fe13a72755372ee2fe509dc6a1..f24f38dd0e91893226a33212642a303fd99d1253 100644 (file)
--- a/doc/README-Interix.txt
+++ b/doc/README-Interix.txt
@@ -1,12 +1,10 @@
 
-                    ngIRCd - Next Generation IRC Server
-
-                      (c)2001-2010 Alexander Barton,
-                   alex@barton.de, http://www.barton.de/
+                     ngIRCd - Next Generation IRC Server
+                           http://ngircd.barton.de/
 
+               (c)2001-2012 Alexander Barton and Contributors.
                ngIRCd is free software and published under the
-                  terms of the GNU General Public License.
-
+                   terms of the GNU General Public License.
 
                          -- README-Interix.txt --
 
@@ -20,10 +18,13 @@ Windows Server 2003. SUA is supported on Windows Server 2003 R2, Windows
 Server 2008 & 2008 R2, Windows Vista, and Windows 7 -- so ngIRCd should be
 able to run on all of these platforms.
 
-But please note that the poll() API function is not fully implemented by
-SFU/SUA and therefore can't be used by ngIRCd -- which normally would be
-the default. Please see <http://www.suacommunity.com/faqs.aspx> section
-4.25 for details:
+But please note that two things:
+
+1. Don't use the poll() IO API
+
+The poll() API function is not fully implemented by SFU/SUA and therefore
+can't be used by ngIRCd -- which normally would be the default. Please see
+<http://www.suacommunity.com/faqs.aspx> section 4.25 for details:
 
   "If you do try to use the poll() API your program will block on the
   API call forever. You must direct your program to build using the
@@ -35,3 +36,9 @@ So when running the ./configure script, you HAVE TO DISABLE poll() support:
 
 ngIRCd then defaults to using the select() API function which works fine.
 
+2. Use GNU make(1)
+
+Starting with ngIRCd 18, our build system doesn't work with the default
+make(1) binary of Interix, you should use GNU make instead (tested with
+version 3.82 built from source).
+