Log4r - A Powerfull Logger for Ruby


This release:      1.0.4
Release date:      2003/09/02
License:           Ruby's 
Maintainer:        Leon Torres <leon@ugcs.caltech.edu>
Contributors:      Martain Stannard, Steve Lumos
Homepage:          http://log4r.sourceforge.net/
Download:          http://sourceforge.net/project/showfiles.php?group_id=43396
SF Project page:   http://sourceforge.net/projects/log4r


Summary
-------

Log4r features an extremely flexible logging library for Ruby. 
Killer features include a heiarchial logging system of any number of 
levels, logger inheritance, multiple output destinations, tracing, custom 
formatting and more. 


Requirements
------------

* (required) Ruby >= 1.7.0 (use log4r 1.0.2 for Ruby 1.6)
* (optional) Ruby syslog library for SyslogOutputter
* (optional) XML configuration requires REXML
* (optional) Remote logging requires ROMP 


More Info
---------

* Installation instructions are in the file INSTALL

* Comprehensive examples are provided in examples/ and can be run right away

* Log4r homepage is in doc/index.html or online at
  http://log4r.sourceforge.net/

* There is a great manual in doc/manual.html or online at:
  http://log4r.sourceforge.net/manual.html
  
* There's also an RDoc API reference in doc/rdoc/index.html or online at:
  http://log4r.sourceforge.net/rdoc/index.html
  
* The changelog has changes by version

* Log4r is hosted by SourceForge, which provides news, bug tracking and a forum


Usability
---------

Log4r works really well, so please take advantage of it right away! :)
All versions since 0.9.2 have been stable and backward-compatible. The
code is stable enough that updates are infrequent and usually only for
adding features or keeping the code up to date with Ruby.


Platform Issues
---------------

Log4r is known to work on Linux and WindowsXP. It's safe to assume that Log4r 
will work on any Ruby-supported platform.


When Trouble Strikes
--------------------

Log4r comes with an internal logger. To see its output, create a logger
named 'log4r' before any others and give it a suitable outputter.

Try running the unit tests provided (run the file tests/runtest.rb). Let
the maintainer know what's up and feelfree to explore and fix the 
code yourself. It's well documented and, of course, written in Ruby. :)

Also, try out the bug tracking system at 
http://sourceforge.net/tracker/?atid=436181&group_id=43396&func=browse


Version: $Id: README,v 1.21 2003/09/03 18:12:59 cepheus Exp $
