README.rdoc in svoop-autotest-growl-0.1.1 vs README.rdoc in svoop-autotest-growl-0.1.4
- old
+ new
@@ -1,30 +1,41 @@
= Autotest Growl
+* Author: Sven Schwyn (http://www.bitcetera.com)
* Homepage: http://www.bitcetera.com/products/autotest-growl
* Issues and forum: https://forge.bitcetera.com/projects/show/autotest-growl
== DESCRIPTION:
This gem aims to improve support for Growl notification by ZenTest's autotest.
It comes with a nice colored Ruby icon set and - for now - supports Cucumber
notifications by means of a workaround.
-Furthermore the terminal running autotest is cleared on every cycle. Don't
-worry though, it's still possible to scroll up to see the output of previous
-cycles.
+The priority of a notification is set according to the actual result so you
+can configure Growl to style the notifications differently based on these
+priorities:
+* 2 for error or failed
+* 0 for info
+* -1 for pending, undefined or unknown
+* -2 for passed
+
+Furthermore the terminal running autotest is cleared on every cycle (unless
+configured otherwise). Don't worry though, it's still possible to scroll up
+to see the output of previous cycles - at least on the Terminal.app from
+Apple.
+
=== Ruby 1.9.1 Note
For the moment, autotest growl doesn't seem to work on Ruby 1.9.1. Fixing this
might take a while though as autotest itself is currently misbehaving on Ruby
1.9 - at least on my setup.
== REQUIREMENTS:
-* Growl >= 1.1.4
-* ZenTest >= 4.1.0
+* Growl >= 1.1.5 (Mac OS X) or >= 2.0b18 (Windows)
+* ZenTest >= 4.1.3
== INSTALL:
First install the gem:
@@ -34,40 +45,71 @@
require 'autotest/growl'
Make sure Growl is installed on your computer. You can download it from:
-http://growl.info
+Mac OS X: http://growl.info
+Windows: http://growlforwindows.com
== CONFIGURATION:
=== Custom Icons
Using your own set of icons is pretty simple. Just create a directory
~/.autotest-growl, copy your icons there and name them passed.png,
-pending.png, failed.png and error.png.
+pending.png, failed.png, error.png and info.png.
+=== Don't Clear the Terminal
+
+Add the following to your ~/.autotest if you don't want the terminal to
+be cleared before running a test:
+
+ Autotest::Growl::clear_terminal = false
+
=== Hide the Label
If you prefer the Growl notifications not to show labels such as "LABEL:
All tests have passed", add the following to your ~/.autotest:
Autotest::Growl::hide_label = true
+=== One Notifications per Run
+
+Allow only one test and one feature notification per run by adding the
+following to your ~/.autotest:
+
+ Autotest::Growl::one_notification_per_run = true
+
+=== Show Modified Files
+
+Add the following to your ~/.autotest if you would like to receive a Growl
+notification listing the files modified before tests are re-run.
+
+ Autotest::Growl::show_modified_files = true
+
== TROUBLESHOOTING:
-=== Missing Cucumber Notifications
+=== Loading the Plugin Seems to Fail
-If you are using autotest-fsevent as well, the require statements are not
-ordered correctly. The require for autotest-fsevent must come after all
-other requires in your ~/.autotest.
+Most likely you still have an old version of ZenTest <= 4.0.0 installed,
+check it with:
-=== Unreliable Growl Notifications
+ gem list ZenTest
-Under some circumstances, Growl notifications seem to be swallowed randomly.
-If this happens to you, try the following.
+To uninstall a specific version (e.g. 4.0.0), type:
+ sudo gem uninstall ZenTest --version=4.0.0
+
+Or remove all outdated versions of all installed gems:
+
+ sudo gem cleanup
+
+=== Unreliable Growl Notifications on Mac OS X
+
+Under some circumstances, Growl notifications seem to be swallowed randomly
+on Mac OS X. If this happens to you, try the following.
+
Add this to your ~/.autotest:
Autotest::Growl::remote_notification = true
Now open "System Preferences -> Growl -> Network" and set the checkboxes
@@ -95,9 +137,17 @@
To contribute code, fork the project on Github, add your code and submit a
pull request:
http://github.com/guides/fork-a-project-and-submit-your-modifications
+
+== CONTRIBUTIONS:
+
+Thanks to the following folks who have contributed to this project:
+
+* Michael Moen
+* Graham Savage
+* Karl O'Keeffe
== LICENSE:
(The MIT License)