trustyRC (version 0.1.1) by eponyme (Nicoleau Fabien) (laste update : 2008-07-07)
===================================================

* Description :
  ===========
   TrustyRC is an IRC Bot written in C++ standard language (easy to host). Its particularity is that it's composed of a kernel
   which only thing it can do is load modules, and only that. Thoses modules are shared librairies written en C++ too.
   The bot can plug and unplug modules at startup, or while running. It makes this bot fully modular, and easy
   to maintain (if a bug is discovered, unload the module, fix it, and reload it, without killing the bot).
   See 'FEATURES' for details about trustyRC's features. This bot run under Linux only.
   This bot use tinyXML library. A patch (tiny_xml-2.5.3-trustyrc.patch) is used fo enable STL and pass -pedantic compilation.

* Folders :
  =======
   Here is trustyrc's tree, whith required files and folders :
   _ trustyrc (root)
   |__ trustyrc.conf
   |__ makefile
   |
   |__ plugins
   |   |__ [shared librairies]
   |   
   |__ src
   |   |__ [bot sources]
   |       |__ [plugins sources]

* Compilation / Installation :
  ==========================
   g++ and make commands are required. No special librairy needed (except for bzrh and fedoraproject modules that needs libcurl-devel package,
   so you'll need it to build all plugins (package name can be also curl-devel, or something like this ...)). 
   In trustyrc's folder, run :
   $ make
   After compilation, you can run the bot from current directory. To install the bot on the system, as root :
   # make install
   You can send those variables to make install command to tweak installation paths or options (Read Makefile for advanced tweak) :
   * PREFIX : change PREFIX (default = /usr/local)
   * DESTDIR : change DESTDIR (default = )
   * LIBDIR : change LIBDIR (you must include prefix in LIBDIR) (default = /usr/local/lib)
   * BINDIR : change BINDIR (you must include prefix and destdir in BINDIR) (default = $(DESTDIR)$(PREFIX)/bin)
	* CONFPLUGDIR : change kernel.plugdir path used in configuration file (default = $(LIBDIR)/$(EXEC))
   * SYSCONFDIR : change SYSCONFDIR (you must include destdir in SYSCONFDIR) (defaut = $(DESTDIR)/etc)
   * HAVE_TINYXML : If you have "tinyxml" installed on your system and want to use it, pass HAVE_TINYXML=yes to 'make' and 'make install' commands.
     Else embeded tinyxml sources will be used (2.5.3) (default = no)
   * PARANOID : switch paranoid mode (default = yes)
   * DEBUG : switch debug mode (default = no)

   All parameters will be stored in "make_install_params" file (you'll have to use thode parameters for uninstall command to use same pathes)

   Note that if you don't have root permissions, you can juste type 'make' and launch the bot from the current directory.


* Uninstallation :
  ==============
   To uninstall the software, type :
   # make uninstall
   Don't forget to apply same parameters that you used for 'make install'. To remember, 'make_install_params' contains
   install parameters values. 

* Configuration :
  =============
   Edit '/etc/trustyrc.conf' file or copy it to ~/.trustyrc.conf .
   See http://nicoleau.fabien.free.fr/trustyrc_manual/ for detail configuration (kernel and modules)

* Launch :
  ======
   trustyrc [-c configuration_file] [-b] (-c to specify configuration file (default = ~/.trustyrc.conf, then /etc/trustyrc.conf), -b for background launch mode)
   If no configuration file specified, trustyRC will first try ~/.trustyrc.conf, then /etc/trustyrc.conf (then stop :) ).

* Versions :
  =======
   See 'changelog' file.

* Contact :
  =======
  Feel free to contact me :
  - by mail : nicoleau.fabien@gmail.com
  - on IRC : 'eponyme' on irc.freenode.net (or irc.quakenet.org)
  - using comments on trustyRC news : http://nicoleau.fabien.free.fr/weblog/index.php?category/TrustyRC 
