Permalink
Browse files

Update documentation for windows support

  • Loading branch information...
1 parent fc9c5f4 commit 5c93116d6f069bbbc76596db3d9d4ac11b343e63 @stereobooster committed May 7, 2011
Showing with 8 additions and 1 deletion.
  1. +8 −1 README.rdoc
View
@@ -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:

0 comments on commit 5c93116

Please sign in to comment.