From 5c93116d6f069bbbc76596db3d9d4ac11b343e63 Mon Sep 17 00:00:00 2001 From: slavic Date: Sat, 7 May 2011 13:40:45 +0300 Subject: [PATCH] Update documentation for windows support --- README.rdoc | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.rdoc b/README.rdoc index dfeee74..8eeb123 100644 --- a/README.rdoc +++ b/README.rdoc @@ -6,11 +6,12 @@ Guard is a command line tool that easily handle events on files modifications. - {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] suuport on Windows ({rb-fchange, >= 0.0.2}[https://github.com/stereobooster/rb-fchange] required) - Polling on the other operating systems (help us to support more OS). - Automatic & Super fast (when polling is not used) files modifications detection (even new files are detected). - Growl notifications ({growlnotify}[http://growl.info/documentation/growlnotify.php] & {growl gem}[https://rubygems.org/gems/growl] required). - Libnotify notifications ({libnotify gem}[https://rubygems.org/gems/libnotify] required). -- Tested on Ruby 1.8.6, 1.8.7 & 1.9.2. +- Tested on Ruby 1.8.7 & 1.9.2. == Install @@ -56,6 +57,12 @@ And add it to you Gemfile: gem 'libnotify' +=== On Windows + +Install the rb-fchange gem for {Directory Change Notification}[http://msdn.microsoft.com/en-us/library/aa365261(VS.85).aspx] support: + + $ gem install rb-fchange + == Usage Just launch Guard inside your Ruby / Rails project with: