Add doc/Contributing.txt to distribution archive

[ngircd-alex.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 1e96e16e24517cb654db7f52b59b137e4a59efeb..4e1cd2fb7916e779824b1bb08077ff278061fd0c 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -2,7 +2,7 @@
                      ngIRCd - Next Generation IRC Server
                            http://ngircd.barton.de/
 
                      ngIRCd - Next Generation IRC Server
                            http://ngircd.barton.de/
 

-               (c)2001-2011 Alexander Barton and Contributors.
+               (c)2001-2012 Alexander Barton and Contributors.

                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 
                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 


@@ -93,7 +93,8 @@ automake ("configure") should be no problem.
 The normal installation procedure after getting (and expanding) the source
 files (using a distribution archive or GIT) is as following:
 
 The normal installation procedure after getting (and expanding) the source
 files (using a distribution archive or GIT) is as following:
 

-  1) ./autogen.sh      [only necessary when using GIT]
+  0) Satisfy prerequisites
+  1) ./autogen.sh  [only necessary when using GIT]

   2) ./configure
   3) make
   4) make install
   2) ./configure
   3) make
   4) make install


@@ -114,6 +115,30 @@ possible options will be installed there. You'll find its template in the
 doc/ directory: sample-ngircd.conf.
 
 
 doc/ directory: sample-ngircd.conf.
 
 

+0): Satisfy prerequisites
+
+When building from source, you'll need some other software to build ngIRCd:
+for example a working C compiler, make tool, GNU automake and autoconf (only
+when not using a distribution archive), and a few libraries depending on the
+features you want to compile in (like IDENT support, SSL, and PAM).
+
+If you are using one of the "big" operating systems or Linux distributions,
+you can use the following commands to install all the required packages to
+build the sources including all optional features and to run the test suite:
+
+* RedHat / Fedora based distributions:
+
+  yum install \
+    autoconf automake expect gcc glibc-devel gnutls-devel \
+    libident-devel make pam-devel tcp_wrappers-devel telnet zlib-devel
+
+* Debian / Ubuntu based distributions:
+
+  apt-get install \
+    autoconf automake build-essential expect libgnutls-dev \
+    libident-dev libpam-dev libwrap0-dev libz-dev telnet
+
+

 1): "autogen.sh"
 
 The first step, autogen.sh, is only necessary if the configure-script isn't
 1): "autogen.sh"
 
 The first step, autogen.sh, is only necessary if the configure-script isn't


@@ -134,7 +159,7 @@ Again: "end users" do not need this step!
 
 The configure-script is used to detect local system dependencies.
 
 
 The configure-script is used to detect local system dependencies.
 

-In the perfect case, configure should recognise all needed libraries, header
+In the perfect case, configure should recognize all needed libraries, header

 files and so on. If this shouldn't work, "./configure --help" shows all
 possible options.
 
 files and so on. If this shouldn't work, "./configure --help" shows all
 possible options.