README

= Growling Test

Supporting Growling Test version: 0.0.x

GrowlingTest is a tool for notifying test running status by Growl(http://growl.info/).
It is not for build notification, but for you can get test failure
or other running status when you are do something else during test 
running locally, and for fun.

GrowlingTest is only supporting test_unit test framework right now.
Feel free to submit commits for supporting any other test framework.

GrowlingTest sends notification by AppleScript.

== Installation

=== GEM Installation

Run the following if you haven't already:

  gem sources -a http://gems.github.com

Install the gem:

  sudo gem install xli-growling_test

== Usage

After installed growling_test gem, put the following code in your test_helper.rb:

  % require 'rubygems'
  % require 'growling_test'
  
Also, you need Growl(http://growl.info/) installed.

== License

Growling Test is available under an Apache License Version 2.0.

= Other stuff

Author::  Li Xiao <iam@li-xiao.com> WPC <wpc@thoughtworks.com>
Requires:: Ruby 1.8.6 or later
License::  Copyright 2008 by Li Xiao & WPC.
           Released under an Apache License Version 2.0.  See the LICENSE file
           included in the distribution.

== Warranty

This software is provided "as is" and without any express or
implied warranties, including, without limitation, the implied
warranties of merchantibility and fitness for a particular
purpose.