joshbuddy-guard 0.10.0

data/CHANGELOG.md

@@ -0,0 +1,370 @@
+## 0.8.8 - October 21, 2011
+
+### Bug fix
+
+- Fix `guard init` when a guard name is given. ([@rymai][])
+
+## 0.8.7 - October 18, 2011
+
+### Bug fix
+
+- [#166](https://github.com/guard/guard/issues/166): Fix silent failure after re-evaluating Guardfile. (reported by [@dgutov][], fixed by [@rymai][], special thanks to [@dyfrgi][] for the [reproductible test case](https://github.com/dyfrgi/Guard-Broken))
+
+## 0.8.6 - October 17, 2011
+
+### Bug fixes
+
+- [#168](https://github.com/guard/guard/issues/168): Fix `guard init` path to Guardfile template. (reported by [@semperos][])
+- [#167](https://github.com/guard/guard/issues/167): Include objects in changed_paths when Guard allows any return from the watchers. (reported by [@earlonrails][], fixed by [@netzpirat][])
+
+## 0.8.5 - October 17, 2011
+
+### Improvements
+
+- `reload` and `run_all` Guard terminal interactions actions can be scoped to only run on a certain guard or group. ([@thibaudgg][])
+- Add cli option (-i / --no-interactions) to turn off Guard terminal interactions. ([@thibaudgg][])
+- Add support for Growl Notification Transport Protocol. ([@netzpirat][])
+- [#157](https://github.com/guard/guard/issues/157): Allow any return from the Guard watchers. ([@earlonrails][])
+- [#156](https://github.com/guard/guard/issues/156): Log error and diagnostic messages to STDERR. ([@sunaku][])
+- [#152](https://github.com/guard/guard/issues/152): Growl Notify API update for a graceful fail. ([@scottdavis][])
+
+### Bug fix
+
+- [#160](https://github.com/guard/guard/issues/160): Avoid `Guard is not missing constant ...` exceptions. (reported by [@earlonrails][], fixed by [@netzpirat][])
+
+## 0.8.4 - October 3, 2011
+
+### Bug fix
+
+- [#149](https://github.com/guard/guard/issues/149) & [#150](https://github.com/guard/guard/issues/150): Fix issue where interator thread was continuing to capture input from stdin while a guard is being executed. (reported by [@hardipe][], fixed by [@f1sherman][])
+
+## 0.8.3 - October 1, 2011
+
+### Bug fix
+
+- [#145](https://github.com/guard/guard/issues/145): Fix over-utilization of CPU in Interactor. ([@johnbintz][])
+
+### Improvements
+
+- [#146](https://github.com/guard/guard/issues/146): Use a mutex instead of a lock for more efficient/simple locking. ([@f1sherman][])
+- Make Guard implementation of `:task_has_failed` simple. ([@netzpirat][])
+
+## 0.8.2 - September 30, 2011
+
+### Bug fix
+
+- Fixed guard stop to prevent run_guard_task(:stop) to be skipped [guard-spork issue #28](https://github.com/guard/guard-spork/issues/28). ([@thibaudgg][])
+
+### Improvement
+
+- Update docs regarding :task_has_failed. ([@netzpirat][])
+
+## 0.8.1 - September 29, 2011
+
+### Bug fix
+
+- [#144](https://github.com/guard/guard/issues/144): Fix `guard init`. (reported by [@fabioyamate][], fixed by [@rymai][])
+
+## 0.8.0 - September 28, 2011
+
+### Bug fixes
+
+- [#137](https://github.com/guard/guard/issues/137): Fix interacting with tools like ruby-debug. ([@hron][] & [@netzpirat][])
+- [#138](https://github.com/guard/guard/issues/138): Fixed comments in example scaffold to reference interactions. ([@rmm5t][] & [@netzpirat][])
+
+### New feature
+
+- [#136](https://github.com/guard/guard/issues/136): New CLI `:watch_all_modifications`/`-A` option to watch for deleted and moved files too. ([@limeyd][] & [@netzpirat][])
+- [#97](https://github.com/guard/guard/issues/97): Guard dependencies. Task execution can now be halted if a Guard throws `:task_has_failed` and `Guard::Dsl#group` options include `:halt_on_fail => true`. ([@rymai][])
+- [#121](https://github.com/guard/guard/issues/121): `Guard.guards` and `Guard.groups` are now smart accessors. Filters can be passed to find a specific Guard/group or several Guards/groups that match (see YARDoc). ([@rymai][] & [@ches][])
+- New `Guard::Group` class to store groups defined in Guardfile (with `Guard::Dsl#group`). ([@rymai][])
+
+### Improvements
+
+- Specs refactoring. ([@netzpirat][])
+- Full YARD documentation. ([@netzpirat][] & a little of [@rymai][])
+
+## 0.7.0 - September 14, 2011
+
+## 0.7.0.rc1 - September 5, 2011
+
+### Major Changes
+
+- Posix Signals handlers (`Ctrl-C`, `Ctrl-\` and `Ctrl-Z`) are no more supported and replaced by `$stdin.gets`. Please refer to the "Interactions" section in the README for more information. ([@thibaudgg][])
+- JRuby & Rubinius support (beta). ([@thibaudgg][] & [@netzpirat][])
+
+### New features
+
+- [#42](https://github.com/guard/guard/issues/42): New DSL method: `callback` allows you to execute arbitrary code before or after any of the `start`, `stop`, `reload`, `run_all` and `run_on_change` guards' method. New [Wiki page](https://github.com/guard/guard/wiki/Hooks-and-callbacks) for documenting it. ([@monocle][] & [@rymai][])
+- Ability to 'pause' files modification listening. Please refer to the "Interactions" section in the README for more information. ([@thibaudgg][])
+
+### Improvement
+
+- Remove the need to scan the whole directory after guard's `run_on_change` method. ([@thibaudgg][])
+
+## 0.6.3 - September 1, 2011
+
+### New features
+
+- [#130](https://github.com/guard/guard/issues/130): Adds `ignore_paths` method to DSL. ([@ianwhite][])
+- [#128](https://github.com/guard/guard/issues/128): Users can add additional settings to `~/.guard.rb` that augment the existing Guardfile. ([@tpope][])
+
+## 0.6.2 - August 17, 2011
+
+### Bug fixes
+
+- Re-add the possibility to use the `growl` gem since the `growl_notify` gem this is currently known to not work in conjunction with Spork. ([@netzpirat][])
+- Ensure that scoped groups and group name are symbolized before checking for inclusion. ([@rymai][])
+
+### New features
+
+- Groups are now stored in a `@groups` variable (will be used for future features). ([@rymai][])
+- Guards will now receive their group in the options hash at initialization (will be used for future features). ([@rymai][])
+
+### Improvement
+
+- Explain the growl/growl_notify differences in the README. ([@netzpirat][])
+
+## 0.6.1 - August 15, 2011
+
+### Bug fixes
+
+- [#120](https://github.com/guard/guard/issues/120): remove `guardfile_contents` when re-evaluating so that the Guardfile gets reloaded correctly. ([@mordaroso][])
+- [#119](https://github.com/guard/guard/issues/119): `Dsl.evaluate_guardfile` uses all groups if none specified. ([@ches][])
+
+## 0.6.0 - August 13, 2011
+
+### Bug fixes
+
+- Pull request [#107](https://github.com/guard/guard/issues/107): Small spelling fix. ([@dnagir][])
+- `Dir.glob` now ignores files that don't need to be watched. ([@rymai][])
+
+### New feature
+
+- Pull request [#112](https://github.com/guard/guard/issues/112): Add `list` command to CLI. ([@docwhat][])
+
+### Improvements
+
+- [#99](https://github.com/guard/guard/issues/99): [OS X] Switch from growl gem to growl_notify gem. ([@johnbintz][])
+- [#115](https://github.com/guard/guard/issues/115): [Linux] Add `:transient => true` to default libnotify options. ([@zonque][])
+- [#95](https://github.com/guard/guard/issues/95): Output system commands and options to be executed when in debug mode. ([@uk-ar][] and [@netzpirat][])
+- `Guard::Dsl.revaluate_guardfile` has been renamed to `Guard::Dsl.reevaluate_guardfile`. ([@rymai][])
+- New CLI options: ([@nestegg][])
+  - `watchdir`/`-w` to specify the directory in which Guard should watch for changes,
+  - `guardfile`/`-G` to specify an alternate location for the Guardfile to use.
+- [#90](https://github.com/guard/guard/issues/90): Refactoring of color handling in the `Guard::UI`. ([@stereobooster][])
+
+## 0.5.1 - July 2, 2011
+
+### Bug fix
+
+- Fixed `guard show` command. ([@bronson][] & [@thibaudgg][])
+
+## 0.5.0 - July 2, 2011
+
+### New features
+
+- Guard::Ego is now part of Guard, so Guardfile is automagically re-evaluated when modified. ([@thibaudgg][])
+- [#91](https://github.com/guard/guard/issues/91): Show Guards in Guardfile with the `guard -T`. ([@johnbintz][])
+
+### Improvements
+
+- [#98](https://github.com/guard/guard/issues/98): Multiple calls per watch event on linux with rb-inotify. ([@jeffutter][] & [@netzpirat][])
+- [#94](https://github.com/guard/guard/issues/94): Show backtrace in terminal when a problem with a watch action occurs. ([@capotej][])
+- [#88](https://github.com/guard/guard/issues/88): Write exception trace in the terminal when a supervised task fail. ([@mcmire][])
+- Color in red the "ERROR:" flag when using `UI.error`. ([@rymai][])
+- [#79](https://github.com/guard/guard/issues/79) and Pull request [#82](https://github.com/guard/guard/issues/82): Improve INotify support on Linux. ([@Gazer][] & [@yannlugrin][])
+- [#12](https://github.com/guard/guard/issues/12) and Pull request [#86](https://github.com/guard/guard/issues/86): Eventually exits with SystemStackError. ([@stereobooster][])
+- [#84](https://github.com/guard/guard/issues/84): Use RbConfig instead of obsolete and deprecated Config. ([@etehtsea][])
+- [#80](https://github.com/guard/guard/issues/80): Watching dotfile (hidden files under unix). (reported by [@chrisberkhout][], fixed by [@yannlugrin][])
+- Clear the terminal on start when the `:clear` option is given. ([@rymai][])
+- Rename home directory Guardfile to `.Guardfile`. ([@tpope][])
+
+## 0.4.2 - June 7, 2011
+
+### Bug fixes
+
+- Fixed Guard::Version in ruby 1.8.7 ([@thibaudgg][])
+- Fix ([@mislav][]) link in CHANGELOG (Note: this is a recursive CHANGELOG item). ([@fnichol][])
+
+## 0.4.1 - June 7, 2011
+
+### Improvements
+
+- [#77](https://github.com/guard/guard/issues/77): Refactor `get_guard_class` to first try the constant and fallback to require + various tweaks. ([@mislav][])
+- Notifier improvement, don't use system notification library if could not be required. ([@yannlugrin][])
+
+## 0.4.0 - June 5, 2011
+
+### Bug fix
+
+- In Ruby < 1.9, `Symbol#downcase` doesn't exist! ([@rymai][])
+
+### New features
+
+- [#73](https://github.com/guard/guard/issues/73): Allow DSL's `group` method to accept a Symbol as group name. ([@johnbintz][])
+- [#51](https://github.com/guard/guard/issues/51): Allow options (like `:priority`) to be passed through to the Notifier. ([@indirect][] & [@netzpirat][])
+
+### Improvement
+
+- [#74](https://github.com/guard/guard/issues/74): Added link definitions to make the CHANGELOG more DRY! That's for sure now, we have the cleanest CHANGELOG ever! (even the link definitions are sorted alphabetically!) ([@pcreux][])
+
+## 0.4.0.rc - May 28, 2011
+
+### Bug fixes
+
+- [#69](https://github.com/guard/guard/issues/69): Fixed typo in README: `Ctr-/` => `Ctr-\`. ([@tinogomes][])
+- [#66](https://github.com/guard/guard/issues/66): Support for dashes in guard names. ([@johnbintz][])
+- Require `guard/ui` because `Guard::Notifier` can be required without full Guard. ([@yannlugrin][])
+- Handled quick file (<1s) modification. Avoid to catch modified files without content modification (sha1 checksum). ([@thibaudgg][] & [@netzpirat][])
+- Fixed `Guard::Notifier` (when growl/libnotify not present). ([@thibaudgg][])
+- Fixed Rubygems deprecation messages. ([@thibaudgg][])
+
+### New features
+
+- [#67](https://github.com/guard/guard/issues/67): Allow Guardfile in `$HOME` folder. ([@hashrocketeer][])
+- [#64](https://github.com/guard/guard/issues/64): Windows notifications support. ([@stereobooster][])
+- [#63](https://github.com/guard/guard/issues/63): Refactor listeners to work as a library. ([@niklas][])
+- Use `ENV["GUARD_NOTIFY"]` to disable notifications. ([@thibaudgg][])
+- Cleaning up all specs. ([@netzpirat][])
+- [#60](https://github.com/guard/guard/issues/60): Added Windows support. ([@stereobooster][])
+- [#58](https://github.com/guard/guard/issues/58): Extract code from signal handlers into methods. ([@nicksieger][])
+- [#55](https://github.com/guard/guard/issues/55): It is now possible to pass `:guardfile` (a Guardfile path) or `:guardfile_contents` (the content of a Guardfile) to `Guard::Dsl.evaluate_guardfile`. Hence this allows the use of `Guard::Dsl.evaluate_guardfile` in a programmatic manner. ([@anithri][], improved by [@rymai][])
+
+## 0.3.4 - April 24, 2011
+
+### Bug fix
+
+- [#41](https://github.com/guard/guard/issues/41): Removed useless Bundler requirement. ([@thibaudgg][])
+
+### New features
+
+- Changed CHANGELOG from RDOC to Markdown and cleaned it! Let's celebrate! ([@rymai][])
+- Changed README from RDOC to Markdown! Let's celebrate! ([@thibaudgg][])
+- [#48](https://github.com/guard/guard/issues/48): Adding support for inline Guard classes rather than requiring a gem. ([@jrsacks][])
+
+## 0.3.3 - April 18, 2011
+
+### Bug fix
+
+- Fixed `new_modified_files` rerun conditions on `Guard.run_on_change_for_all_guards`. ([@thibaudgg][])
+
+## 0.3.2 - April 17, 2011
+
+### Bug fixe
+
+- [#43](https://github.com/guard/guard/issues/43): Fixed `guard init` command. ([@brainopia][])
+
+## 0.3.1 - April 14, 2011
+
+### Bug fixes
+
+- Return unique filenames from Linux listener. (Marian Schubert)
+- `Guard.get_guard_class` return wrong class when loaded nested class. ([@koshigoe][])
+- [#35](https://github.com/guard/guard/issues/35): Fixed open-gem/gem_open dependency problem by using `gem which` to locate guards gem path. (reported by [@thierryhenrio][], fixed by [@thibaudgg][])
+- [#38](https://github.com/guard/guard/issues/38) & Pull request [#39](https://github.com/guard/guard/issues/39): Fixed an invalid ANSI escape code in `Guard::UI.reset_line`. ([@gix][])
+
+### New feature
+
+- [#28](https://github.com/guard/guard/issues/28): New `-n` command line option to disable notifications (Growl / Libnotify). ([@thibaudgg][])
+
+## 0.3.0 - January 19, 2011
+
+### Bug fix
+
+- Avoid launching `run_on_change` guards method when no files matched. `--clear` guard argument is now usable. ([@thibaudgg][])
+
+### New features
+
+- The whole directory is now watched during `run_on_change` to detect new files modifications. ([@thibaudgg][])
+- [#26](https://github.com/guard/guard/issues/26): New DSL method: `group` allows you to group several guards. New CLI option: `--group group_name` to specify certain groups of guards to start. ([@netzpirat][])
+- `watch` patterns are now more strict: strings are matched with `String#==`, `Regexp` are matched with `Regexp#match`. ([@rymai][])
+- A deprecation warning is displayed if your `Guardfile` contains `String` that look like `Regexp` (bad!). ([@rymai][])
+- It's now possible to return an `Enumerable` in the `watch` optional blocks in the `Guardfile`. ([@rymai][])
+
+### New specs
+
+- `Guard::Watcher`. ([@rymai][])
+- [#13](https://github.com/guard/guard/issues/13): `Guard::Dsl`. ([@oliamb][])
+
+## 0.2.2 - October 25, 2010
+
+### Bug fix
+
+- [#5](https://github.com/guard/guard/issues/5): avoid creating new copy of `fsevent_watch` every time a file is changed. (reported by [@stouset][], fixed by [@thibaudgg][])
+
+## 0.2.1 - October 24, 2010
+
+### Bug fixes
+
+- [#7](https://github.com/guard/guard/issues/7): Fixes for Linux support. ([@yannlugrin][])
+- [#6](https://github.com/guard/guard/issues/6): Locate guard now chomp newline in result path. ([@yannlugrin][])
+
+## 0.2.0 - October 21, 2010
+
+### Bug fixes
+
+- [#3](https://github.com/guard/guard/issues/3): `guard init <guard-name>` no more need `Gemfile` but `open_gem` is required now. (reported by [@wereHamster][], fixed by [@thibaudgg][])
+- [#2](https://github.com/guard/guard/issues/2): 1.8.6 compatibility. (reported by [@veged][], fixed by [@thibaudgg][])
+- Removes Growl & Libnotify dependencies. ([@thibaudgg][])
+
+## 0.2.0.beta.1 - October 17, 2010
+
+### New features
+
+- Improved listeners support (`rb-fsevent` & `rb-inotify`). ([@thibaudgg][])
+- Added polling listening fallback. ([@thibaudgg][])
+
+[@anithri]: https://github.com/anithri
+[@brainopia]: https://github.com/brainopia
+[@bronson]: https://github.com/bronson
+[@capotej]: https://github.com/capotej
+[@ches]: https://github.com/ches
+[@chrisberkhout]: https://github.com/chrisberkhout
+[@dgutov]: https://github.com/dgutov
+[@dnagir]: https://github.com/dnagir
+[@docwhat]: https://github.com/docwhat
+[@dyfrgi]: https://github.com/dyfrgi
+[@earlonrails]: https://github.com/earlonrails
+[@etehtsea]: https://github.com/etehtsea
+[@f1sherman]: https://github.com/f1sherman
+[@fabioyamate]: https://github.com/fabioyamate
+[@fnichol]: https://github.com/fnichol
+[@Gazer]: https://github.com/Gazer
+[@gix]: https://github.com/gix
+[@hron]: https://github.com/hron
+[@hardipe]: https://github.com/hardipe
+[@hashrocketeer]: https://github.com/hashrocketeer
+[@ianwhite]: https://github.com/ianwhite
+[@indirect]: https://github.com/indirect
+[@jeffutter]: https://github.com/jeffutter
+[@johnbintz]: https://github.com/johnbintz
+[@jrsacks]: https://github.com/jrsacks
+[@koshigoe]: https://github.com/koshigoe
+[@limeyd]: https://github.com/limeyd
+[@mcmire]: https://github.com/mcmire
+[@mislav]: https://github.com/mislav
+[@monocle]: https://github.com/monocle
+[@mordaroso]: https://github.com/mordaroso
+[@nestegg]: https://github.com/nestegg
+[@netzpirat]: https://github.com/netzpirat
+[@nicksieger]: https://github.com/nicksieger
+[@niklas]: https://github.com/niklas
+[@oliamb]: https://github.com/oliamb
+[@pcreux]: https://github.com/pcreux
+[@rmm5t]: https://github.com/rmm5t
+[@rymai]: https://github.com/rymai
+[@scottdavis]: https://github.com/scottdavis
+[@semperos]: https://github.com/semperos
+[@stereobooster]: https://github.com/stereobooster
+[@stouset]: https://github.com/stouset
+[@sunaku]: https://github.com/sunaku
+[@thibaudgg]: https://github.com/thibaudgg
+[@thierryhenrio]: https://github.com/thierryhenrio
+[@tinogomes]: https://github.com/tinogomes
+[@tpope]: https://github.com/tpope
+[@uk-ar]: https://github.com/uk-ar
+[@veged]: https://github.com/veged
+[@wereHamster]: https://github.com/wereHamster
+[@yannlugrin]: https://github.com/yannlugrin
+[@zonque]: https://github.com/zonque

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Thibaud Guillaume-Gentil
+
+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,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,470 @@
+Guard [![Build Status](https://secure.travis-ci.org/guard/guard.png?branch=master)](http://travis-ci.org/guard/guard)
+=====
+
+Guard is a command line tool to easily handle events on file modifications.
+
+If you have any questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
+
+Features
+--------
+
+* [FSEvent](http://en.wikipedia.org/wiki/FSEvents) support on Mac OS X 10.5+ (without RubyCocoa!, [rb-fsevent gem, >= 0.3.5](https://rubygems.org/gems/rb-fsevent) required).
+* [Inotify](http://en.wikipedia.org/wiki/Inotify) support on Linux ([rb-inotify gem, >= 0.5.1](https://rubygems.org/gems/rb-inotify) required).
+* [Directory Change Notification](http://msdn.microsoft.com/en-us/library/aa365261\(VS.85\).aspx) support on Windows ([rb-fchange, >= 0.0.2](https://rubygems.org/gems/rb-fchange) required).
+* Polling on the other operating systems (help us to support more OS).
+* Automatic & Super fast (when polling is not used) file modifications detection (even new files are detected).
+* Visual notifications on Mac OSX ([Growl](http://growl.info)), Linux ([Libnotify](http://developer.gnome.org/libnotify)) and Windows ([Notifu](http://www.paralint.com/projects/notifu)).
+* Tested against Ruby 1.8.7, 1.9.2, REE and the latest versions of JRuby & Rubinius.
+
+Screencast
+----------
+
+Ryan Bates made a Railscast on Guard, you can view it here: [http://railscasts.com/episodes/264-guard](http://railscasts.com/episodes/264-guard)
+
+Install
+-------
+
+Add Guard to your `Gemfile`:
+
+    group :development do
+      gem 'guard'
+    end
+
+and install it via Bundler:
+
+    $ bundle
+
+Generate an empty Guardfile with:
+
+    $ guard init
+
+You may optionally place a .Guardfile in your home directory to use it across multiple projects.
+Also note that if a `.guard.rb` is found in your home directory, it will be appended to the Guardfile.
+
+Add the guards you need to your Guardfile (see the existing guards below).
+
+Now, be sure to read the particular instructions for your operating system: [Mac OS X](#mac) | [Linux](#linux) | [Windows](#win)
+
+<a name="mac" />
+
+### On Mac OS X
+
+Install the rb-fsevent gem for [FSEvent](http://en.wikipedia.org/wiki/FSEvents) support:
+
+    $ gem install rb-fsevent
+
+You have three possibilities for getting Growl support:
+
+Use the [growl_notify gem](https://rubygems.org/gems/growl_notify):
+
+    $ gem install growl_notify
+
+The `growl_notify` gem is compatible with Growl >= 1.3 and uses AppleScript to send Growl notifications.
+The gem needs a native C extension to make use of AppleScript and does not run on JRuby and MacRuby.
+
+Use the [ruby_gntp gem](https://github.com/snaka/ruby_gntp):
+
+    $ gem install ruby_gntp
+
+The `ruby_gntp` gem is compatible with Growl >= 1.3 and uses the Growl Notification Transport Protocol to send Growl
+notifications. Guard supports multiple notification channels for customizing each notification type, but it's limited
+to the local host currently.
+
+Use the [growl gem](https://rubygems.org/gems/growl):
+
+    $ gem install growl
+
+The `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. You can also install it with HomeBrew:
+
+    $ brew install growlnotify
+
+Finally you have to add your Growl library of choice to your Gemfile:
+
+    gem 'rb-fsevent'
+    gem 'growl_notify' # or gem 'ruby_gntp' or gem 'growl'
+
+Have a look at the [Guard Wiki](https://github.com/guard/guard/wiki/Which-Growl-library-should-I-use) for more information.
+
+<a name="linux" />
+
+### On Linux
+
+Install the [rb-inotify gem](https://rubygems.org/gems/rb-inotify) for [inotify](http://en.wikipedia.org/wiki/Inotify) support:
+
+    $ gem install rb-inotify
+
+Install the [libnotify gem](https://rubygems.org/gems/libnotify) if you want visual notification support:
+
+    $ gem install libnotify
+
+And add them to your Gemfile:
+
+    gem 'rb-inotify'
+    gem 'libnotify'
+
+<a name="win" />
+
+### On Windows
+
+Install the [rb-fchange gem](https://rubygems.org/gems/rb-fchange) for [Directory Change Notification](http://msdn.microsoft.com/en-us/library/aa365261\(VS.85\).aspx) support:
+
+    $ gem install rb-fchange
+
+Install the [win32console gem](https://rubygems.org/gems/win32console) if you want colors in your terminal:
+
+    $ gem install win32console
+
+Install the [rb-notifu gem](https://rubygems.org/gems/rb-notifu) if you want visual notification support:
+
+    $ gem install rb-notifu
+
+And add them to your Gemfile:
+
+    gem 'rb-fchange'
+    gem 'rb-notifu'
+    gem 'win32console'
+
+Usage
+-----
+
+Just launch Guard inside your Ruby / Rails project with:
+
+    $ guard [start]
+
+or if you use Bundler, to run the Guard executable specific to your bundle:
+
+    $ bundle exec guard [start]
+
+Guard will look for a Guardfile in your current directory. If it does not find one, it will look in your `$HOME` directory for a .Guardfile.
+
+Command line options
+--------------------
+
+### `-c`/`--clear` option
+
+Shell can be cleared after each change:
+
+    $ guard --clear
+    $ guard -c # shortcut
+
+### `-n`/`--notify` option
+
+Notifications (growl/libnotify) can be disabled:
+
+    $ guard --notify false
+    $ guard -n f # shortcut
+
+Notifications can also be disabled globally by setting a `GUARD_NOTIFY` environment variable to `false`
+
+### `-g`/`--group` option
+
+Only certain guards groups can be run (see the Guardfile DSL below for creating groups):
+
+    $ guard --group group_name another_group_name
+    $ guard -g group_name another_group_name # shortcut
+
+### `-d`/`--debug` option
+
+Guard can be run in debug mode:
+
+    $ guard --debug
+    $ guard -d # shortcut
+
+### `-w`/`--watchdir` option
+
+Guard can watch in any directory (instead of the current directory):
+
+    $ guard --watchdir ~/your/fancy/project
+    $ guard -w ~/your/fancy/project # shortcut
+
+### `-G`/`--guardfile` option
+
+Guard can use a Guardfile not located in the current directory:
+
+    $ guard --guardfile ~/.your_global_guardfile
+    $ guard -G ~/.your_global_guardfile # shortcut
+
+### `-A`/`--watch-all-modifications` option
+
+Guard can optionally watch all file modifications like moves or deletions with:
+
+    $ guard start -A
+    $ guard start --watch-all-modifications
+
+### `-i`/`--no-interactions` option
+
+Turn off completely any Guard terminal [interactions](#interactions) with:
+
+    $ guard start -i
+    $ guard start --no-interactions
+
+### `-I`/`--no-vendor` option
+
+Ignore the use of vendored gems with:
+
+    $ guard start -I
+    $ guard start --no-vendor
+
+An exhaustive list of options is available with:
+
+    $ guard help [TASK]
+
+<a name="interactions" />
+
+Interactions
+------------
+
+**From version >= 0.7.0 Posix Signal handlers are no more used to interact with Guard. If you're using a version < 0.7, please refer to the [README in the v0.6 branch](https://github.com/guard/guard/blob/v0.6/README.md).**
+
+When Guard do nothing you can interact with by entering a command + hitting return/enter:
+
+* `stop`:    `stop|quit|exit|s|q|e + return` - Calls each guard's `#stop` method, in the same order they are declared in the Guardfile, and then quits Guard itself.
+* `reload`:  `reload|r|z + return` - Calls each guard's `#reload` method, in the same order they are declared in the Guardfile.
+* `pause`:   `pause|p + return` - Toggle file modification listening. Useful when switching git branches.
+* `run_all`: `just return (no commands)` - Calls each guard's `#run_all` method, in the same order they are declared in the Guardfile.
+
+`reload` and `run_all` actions can be scoped to only run on a certain guard or group. Examples:
+
+* `backend reload + return` - Call only each guard's `#reload` method on backend group.
+* `rspec + return` - Call only rspec guard's `#run_all` method.
+
+Available Guards
+----------------
+
+A list of the available guards is present [in the wiki](https://github.com/guard/guard/wiki/List-of-available-Guards).
+
+### Add a guard to your Guardfile
+
+Add it to your Gemfile (inside the `development` group):
+
+    gem '<guard-name>'
+
+You can list all guards installed on your system with:
+
+    $ guard list
+
+Insert default guard's definition to your Guardfile by running this command:
+
+    $ guard init <guard-name>
+
+You are good to go, or you can modify your guards' definition to suit your needs.
+
+Guardfile DSL
+-------------
+
+The Guardfile DSL consists of the following methods:
+
+* `#guard`        - Allows you to add a guard with an optional hash of options.
+* `#watch`        - Allows you to define which files are supervised by a guard. An optional block can be added to overwrite the paths sent to the guard's `#run_on_change` method or to launch any arbitrary command.
+* `#group`        - Allows you to group several guards together. Groups to be run can be specified with the Guard DSL option `--group` (or `-g`). This comes in handy especially when you have a huge Guardfile and want to focus your development on a certain part. Guards that don't belong to a group are considered global and are always run.
+* `#callback`     - Allows you to execute arbitrary code before or after any of the `start`, `stop`, `reload`, `run_all` and `run_on_change` guards' method. You can even insert more hooks inside these methods. Please [checkout the Wiki page](https://github.com/guard/guard/wiki/Hooks-and-callbacks) for more details.
+* `#ignore_paths` - Allows you to ignore top level directories altogether. This comes is handy when you have large amounts of non-source data in you project.  By default .bundle, .git, log, tmp, and vendor are ignored.  Currently it is only possible to ignore the immediate descendants of the watched directory.
+
+Example:
+
+    ignore_paths 'foo', 'bar'
+
+    group 'backend' do
+      guard 'bundler' do
+        watch('Gemfile')
+      end
+
+      guard 'rspec', :cli => '--color --format doc' do
+        # Regexp watch patterns are matched with Regexp#match
+        watch(%r{^spec/.+_spec\.rb$})
+        watch(%r{^lib/(.+)\.rb$})         { |m| "spec/lib/#{m[1]}_spec.rb" }
+        watch(%r{^spec/models/.+\.rb$})   { ["spec/models", "spec/acceptance"] }
+        watch(%r{^spec/.+\.rb$})          { `say hello` }
+
+        # String watch patterns are matched with simple '=='
+        watch('spec/spec_helper.rb') { "spec" }
+      end
+    end
+
+    group 'frontend' do
+      guard 'coffeescript', :output => 'public/javascripts/compiled' do
+        watch(%r{^app/coffeescripts/.+\.coffee$})
+      end
+
+      guard 'livereload' do
+        watch(%r{^app/.+\.(erb|haml)$})
+      end
+    end
+
+Using a Guardfile without the `guard` binary
+--------------------------------------------
+
+The Guardfile DSL can also be used in a programmatic fashion by calling directly `Guard::Dsl.evaluate_guardfile`.
+Available options are as follow:
+
+* `:guardfile`          - The path to a valid Guardfile.
+* `:guardfile_contents` - A string representing the content of a valid Guardfile
+
+Remember, without any options given, Guard will look for a Guardfile in your current directory and if it does not find one, it will look for it in your `$HOME` directory.
+
+For instance, you could use it as follow:
+
+    gem 'guard'
+    require 'guard'
+
+    Guard.setup
+
+    Guard::Dsl.evaluate_guardfile(:guardfile => '/your/custom/path/to/a/valid/Guardfile')
+    # or
+    Guard::Dsl.evaluate_guardfile(:guardfile_contents => "
+      guard 'rspec' do
+        watch(%r{^spec/.+_spec\.rb$})
+      end
+    ")
+
+    Guard.start
+
+### Listing defined guards/groups for the current project
+
+You can list the defined groups and guards for the current Guardfile from the command line using `guard show` or `guard -T`:
+
+    $ guard -T
+
+    (global):
+      shell
+    Group backend:
+      bundler
+      rspec: cli => "--color --format doc"
+    Group frontend:
+      coffeescript: output => "public/javascripts/compiled"
+      livereload
+
+User config file
+----------------
+
+If a `.guard.rb` is found in your home directory, it will be appended to
+the Guardfile.  This can be used for tasks you want guard to handle but
+other users probably don't.  For example, indexing your source tree with
+[Ctags](http://ctags.sourceforge.net):
+
+    guard 'shell' do
+      watch(%r{^(?:app|lib)/.+\.rb$}) { `ctags -R` }
+    end
+
+Create a new guard
+------------------
+
+Creating a new guard is very easy, just create a new gem (`bundle gem` if you use Bundler) with this basic structure:
+
+    .travis.yml  # bonus point!
+    CHANGELOG.md # bonus point!
+    Gemfile
+    guard-name.gemspec
+    Guardfile
+    lib/
+      guard/
+        guard-name/
+          templates/
+            Guardfile # needed for `guard init <guard-name>`
+          version.rb
+        guard-name.rb
+    test/ # or spec/
+    README.md
+
+`Guard::GuardName` (in `lib/guard/guard-name.rb`) must inherit from
+[Guard::Guard](http://rubydoc.info/github/guard/guard/master/Guard/Guard) and should overwrite at least one of
+the basic `Guard::Guard` task methods.
+
+Here is an example scaffold for `lib/guard/guard-name.rb`:
+
+    require 'guard'
+    require 'guard/guard'
+
+    module Guard
+      class GuardName < Guard
+
+        # Initialize a Guard.
+        # @param [Array<Guard::Watcher>] watchers the Guard file watchers
+        # @param [Hash] options the custom Guard options
+        def initialize(watchers = [], options = {})
+          super
+        end
+
+        # Call once when Guard starts. Please override initialize method to init stuff.
+        # @raise [:task_has_failed] when start has failed
+        def start
+        end
+
+        # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
+        # @raise [:task_has_failed] when stop has failed
+        def stop
+        end
+
+        # Called when `reload|r|z + enter` is pressed.
+        # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
+        # @raise [:task_has_failed] when reload has failed
+        def reload
+        end
+
+        # Called when just `enter` is pressed
+        # This method should be principally used for long action like running all specs/tests/...
+        # @raise [:task_has_failed] when run_all has failed
+        def run_all
+        end
+
+        # Called on file(s) modifications that the Guard watches.
+        # @param [Array<String>] paths the changes files or paths
+        # @raise [:task_has_failed] when run_on_change has failed
+        def run_on_change(paths)
+        end
+
+        # Called on file(s) deletions that the Guard watches.
+        # @param [Array<String>] paths the deleted files or paths
+        # @raise [:task_has_failed] when run_on_change has failed
+        def run_on_deletion(paths)
+        end
+
+      end
+    end
+
+Please take a look at the [existing guards' source code](https://github.com/guard/guard/wiki/List-of-available-Guards)
+for more concrete example and inspiration.
+
+Alternatively, a new guard can be added inline to a Guardfile with this basic structure:
+
+    require 'guard/guard'
+
+    module ::Guard
+      class InlineGuard < ::Guard::Guard
+        def run_all
+        end
+
+        def run_on_change(paths)
+        end
+      end
+    end
+
+Here is a very cool example by [@avdi](https://github.com/avdi) : [http://avdi.org/devblog/2011/06/15/a-guardfile-for-redis](http://avdi.org/devblog/2011/06/15/a-guardfile-for-redis)
+
+Development
+-----------
+
+* Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard/master/frames).
+* Source hosted at [GitHub](https://github.com/guard/guard).
+* Report issues and feature requests to [GitHub Issues](https://github.com/guard/guard/issues).
+
+Pull requests are very welcome! Please try to follow these simple "rules", though:
+
+- Please create a topic branch for every separate change you make;
+- Make sure your patches are well tested;
+- Update the README (if applicable);
+- Update the CHANGELOG (maybe not for a typo but don't hesitate!);
+- Please **do not change** the version number.
+
+For questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
+
+Author
+------
+
+[Thibaud Guillaume-Gentil](https://github.com/thibaudgg)
+
+Contributors
+------------
+
+[https://github.com/guard/guard/contributors](https://github.com/guard/guard/contributors)