README.rdoc in guard-0.2.0.beta.1 vs README.rdoc in guard-0.2.0
- old
+ new
@@ -2,18 +2,18 @@
Guard is a command line tool to easly handle events on files modifications.
== Features
-- FSEvent support on Mac OS X 10.5+ (without RubyCocoa!, please install {rb-fsevent, >= 0.3.2}[https://rubygems.org/gems/rb-fsevent])
-- Inotify support on Linux (beta, please install {rb-inotify, >= 0.5.1}[https://rubygems.org/gems/rb-inotify])
+- {FSEvent}[http://en.wikipedia.org/wiki/FSEvents] support on Mac OS X 10.5+ (without RubyCocoa!, {rb-fsevent gem, >= 0.3.2}[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)
- Polling for others (help us to support more systems)
- Super fast change detection (when polling not used)
- Automatic files modifications detection (even new files are detected)
-- Growl notification (please install {growlnotify}[http://growl.info/documentation/growlnotify.php])
-- Libnotify notification
-- Tested on Ruby 1.8.7 & 1.9.2.
+- Growl notification ({growlnotify}[http://growl.info/documentation/growlnotify.php] & {growl gem}[https://rubygems.org/gems/growl] required)
+- Libnotify notification ({libnotify gem}[https://rubygems.org/gems/libnotify] required)
+- Tested on Ruby 1.8.6, 1.8.7 & 1.9.2
== Install
Install the gem:
@@ -27,10 +27,30 @@
guard init
Add guard(s) you need (see available guards below)
+=== On Mac OS X
+
+Install rb-fsevent for {FSEvent}[http://en.wikipedia.org/wiki/FSEvents] support
+
+ gem install rb-fsevent
+
+Install growl for Growl notification support
+
+ gem install growl
+
+=== On Linux
+
+Install rb-inotify for {inotify}[http://en.wikipedia.org/wiki/Inotify] support
+
+ gem install rb-inotify
+
+Install libnotify for libonity notification support
+
+ gem install libnotify
+
== Usage
Just launch Guard inside your ruby/rails project with:
guard
@@ -50,17 +70,19 @@
- Ctrl-Z - Call reload guard(s) method
== Available Guards
- {guard-rspec}[http://github.com/guard/guard-rspec]
+- {guard-test}[http://github.com/guard/guard-test]
+- {guard-minitest}[http://github.com/guard/guard-minitest]
- {guard-livereload}[http://github.com/guard/guard-livereload]
+- {guard-sass}[http://github.com/guard/guard-sass]
+- {guard-shell}[http://github.com/guard/guard-shell]
guard ideas:
- guard-spork
- guard-cucumber
-- guard-test
-- guard-sass
- guard-bundler
- others ideas?
=== Add a guard to your Guardfile
\ No newline at end of file