From 2e34275f90793a8b236d95f0088802400660ae35 Mon Sep 17 00:00:00 2001 From: Michael Kessler Date: Sat, 25 Feb 2012 10:47:21 +0100 Subject: [PATCH] Add note about the GNTP issue. [ci skip] --- README.md | 43 +++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index e2b5a397a..ae4f9ea2d 100644 --- a/README.md +++ b/README.md @@ -66,8 +66,31 @@ the time, try the [Rubygems Bundler](https://github.com/mpapis/rubygems-bundler) You can configure Guard to make use of the following system notification libraries, but it's strongly recommended to use either Ruby GNTP, Libnotify or Notifu: +#### Growl + +* Runs on Mac OS X +* Supports all [Growl](http://growl.info/) versions + +The [growl](https://rubygems.org/gems/growl) gem is compatible with all versions of Growl and uses a command line tool +[growlnotify](http://growl.info/extras.php#growlnotify) that must be separately downloaded and installed. The version of +the command line tool must match your Growl version. The `growl` gem does **not** support multiple notification +channels. + +You have to download the installer for `growlnotify` from the [Growl download section](http://growl.info/downloads). + +To use `growl` you have to add it to your `Gemfile` and run bundler: + +```ruby +group :development do + gem 'growl' +end +``` + #### Ruby GNTP +**There's currently a bug in Growl that prevents displaying the icons through GNTP, see +[issue #231](https://github.com/guard/guard/issues/231). Use the growl gem until fixed.** + * Runs on Mac OS X, Linux and Windows * Supports [Growl](http://growl.info/) version >= 1.3, [Growl for Linux](http://mattn.github.com/growl-for-linux/), [Growl for Windows](http://www.growlforwindows.com/gfw/default.aspx) and @@ -124,26 +147,6 @@ group :development do end ``` -#### Growl - -* Runs on Mac OS X -* Supports all [Growl](http://growl.info/) versions - -The [growl](https://rubygems.org/gems/growl) gem is compatible with all versions of Growl and uses a command line tool -[growlnotify](http://growl.info/extras.php#growlnotify) that must be separately downloaded and installed. The version of -the command line tool must match your Growl version. The `growl` gem does **not** support multiple notification -channels. - -You have to download the installer for `growlnotify` from the [Growl download section](http://growl.info/downloads). - -To use `growl` you have to add it to your `Gemfile` and run bundler: - -```ruby -group :development do - gem 'growl' -end -``` - #### GrowlNotify * Runs on Mac OS X