README.txt in chjunior-autotest-notification-0.0.8 vs README.txt in chjunior-autotest-notification-0.2.1
- old
+ new
@@ -1,40 +1,98 @@
= The Autotest Notification Gem
-* http://www.nomedojogo.com/2008/05/12/autotest-notification-gem/
+* http://github.com/carlosbrando/autotest-notification/
+
== DESCRIPTION:
-This gem set the autotest (ZenTest) to send messages to software as Growl or LibNotify, displaying a window with the results.
+This gem set the autotest (ZenTest) to send messages to software as Growl, LibNotify, and Snarl, displaying a window with the results.
-== FEATURES/PROBLEMS:
-* Running on Mac (Growl), Linux (LibNotify) and Windows (Snarl).
-
== REQUIREMENTS:
-* FIX (list of requirements)
+Independent of operating system you are using, you must install the ZenTest:
+ $ gem install ZenTest
+
+
+* If you're using a Mac:
+ You need to have Growl and growlnotify installed on your machine.
+
+ Download the Growl [http://growl.info/index.php] and install it like any other application on your Mac
+
+ Then you must install the growlnotify.
+
+ In your shell, cd to the directory on the Growl disk image containing growlnotify, and type ./install.sh.
+ That script will install growlnotify to /usr/local/bin and the manpage to /usr/local/man.
+
+
+* If you're using Windows (with cygwin):
+ You need to have Snarl and sncmd installed on your machine.
+
+ Download Snarl [http://www.fullphat.net/] and install it like any other application on your machine.
+
+ Then download sncmd [http://www.k23productions.com/download.php?view.105] open the zip file and place
+ the executable from the zip in any directory in windows PATH (for example c:\windows).
+
+
+* If you're using Windows (without cygwin):
+ You need to have Snarl, diffutils and ruby-snarl installed on your machine.
+
+ Download Snarl [http://www.fullphat.net/] and install it like any other application on your machine.
+
+ Download DiffUtils for Windows [http://gnuwin32.sourceforge.net/packages/diffutils.htm] and follow the installation instructions on the site.
+
+ Run in the command prompt:
+
+ $ gem install ruby-snarl
+
+ After all that. You must update the environment variable PATH with the path to the bin of diffutils.
+ It's the price that was paid for using Windows (try cygwin).
+
+
+* If you're using Linux:
+ You need to have libnotify binaries installed.
+
+ For ubuntu this means: sudo apt-get install libnotify-bin
+
+ Other distributions may package it with other names, do a search for libnotify using your distribution package manager.
+
+ If you use KDE and do not have libnotify-bin installed, it will try to use kdialog wich is part of KDE.
+ It also works if you have zenity installed.
+
+
== INSTALL:
- $ sudo gem install carlosbrando-autotest-notification --source=http://gems.github.com
-
-Run it:
+ $ sudo gem install carlosbrando-autotest-notification --source=http://gems.github.com
+
+Run it to let the notifier in automatic mode:
- $ an-install
+ $ an-install
+In Windows without cygwin, it's necessary to install in the directory of the project:
+
+ $ an-install -p C:\projects\my_project
+
+To turn off the notifier:
+
+ $ an-uninstall
+
+
== Contributors
-* carlosbrando
-* simpsomboy
-* urubatan
-* chjunior
+* carlosbrando [http://www.nomedojogo.com]
+* simpsomboy [http://alexandredasilva.wordpress.com]
+* urubatan [http://www.urubatan.info]
+* chjunior [http://tas.milk-it.net]
+* daviscabral [http://blog.impactmedia.com.br]
+* tapajos [http://www.improveit.com.br/tapajos]
== LICENSE:
(The MIT License)
-Copyright (c) 2008 FIX
+Copyright (c) 2008
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,