Author: Antoine Amarilli <firstname.lastname@example.org>
Date: Fri, 9 May 2014 19:11:19 +0200
more precise install instructions and test config
|README|| | ||25||++++++++++++++-----------|
1 file changed, 14 insertions(+), 11 deletions(-)
diff --git a/README b/README
@@ -24,14 +24,17 @@ quickly, either in the shell or in your favourite programming language.
== 2. Installation ==
-irctk is written using libircclient, you will need this library (version >= 1.7
-with SSL support) to compile and run the program. The package is libircclient1
-and libircclient-dev on Debian but it is outdated as of this writing, hence you
-should download the lib from <https://sourceforge.net/projects/libircclient/>
-and compile it and install it (this requires the package libssl-dev, and of
-course make, a C compiler, etc., which you can get on Debian system by
-installing e.g. the package build-essential):
+irctk is written using libircclient, you will need this library to compile and
+run the program. The package is libircclient1 and libircclient-dev on Debian but
+it is outdated as of this writing, and the latest 1.7 release of the library has
+a bug which was only fixed in the svn version (revision 120). Hence, you should
+get the latest library from the SVN (tested as of revision 125), compile it and
+install it (this requires the package libssl-dev, and of course make, a C
+compiler, etc., which you can get on Debian system by installing e.g. the
+ svn checkout svn://svn.code.sf.net/p/libircclient/code/trunk/libircclient
+ cd libircclient
./configure --enable-openssl --enable-shared
sudo make install
@@ -40,9 +43,9 @@ Once this is done, run "make" to compile irctk. Install it by yourself in a
location of your PATH if you want to use it as "irctk", otherwise replace
"irctk" by "./irctk" in the next examples.
-In case of a segfault in manage_event, please double-check that you have
+[In case of a segfault in manage_event, please double-check that you have
compiled against the right version of libircclient (see above) before reporting
-a bug, as this is known behavior when using older versions of libircclient.
+a bug, as this is known behavior when using older versions of libircclient.]
== 3. How to use ==
@@ -412,7 +415,7 @@ things down.
You can run the test suite with ./tests_sequential.sh. This requires a working
IRC server on localhost:6667. I use ircd-hybrid from Debian testing, configured
-with throttle_time = 0.
+with throttle_time = 0 and anti_spam_exit_message_time = 0.
If you have GNU parallel and if your IRC server isn't afraid of many connections
from a single IP, you can run the tests in parallel: ./tests_parallel.sh. This