README.rdoc in guard-0.1.1 vs README.rdoc in guard-0.2.0.beta.1
- old
+ new
@@ -2,21 +2,21 @@
Guard is a command line tool to easly handle events on files modifications.
== Features
-- FSEvent support on Mac OS X (without RubyCocoa!)
-- Inotify support on Linux (beta)
-- Super fast change detection
+- 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])
+- 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.
== Install
-Only Mac OS X (10.5+) & Linux are supported. Tested on Ruby 1.8.7 & 1.9.2.
-
Install the gem:
gem install guard
Add it to your Gemfile (inside test group):
@@ -33,28 +33,32 @@
Just launch Guard inside your ruby/rails project with:
guard
+Shell can be cleared after each change with:
+
+ guard -c
+
Options list is available with:
- guard help
+ guard help [TASK]
Signal handlers are used to interact with Guard:
- Ctrl-C - Quit Guard (call stop guard(s) method before)
- Ctrl-\ - Call run_all guard(s) method
- Ctrl-Z - Call reload guard(s) method
== Available Guards
- {guard-rspec}[http://github.com/guard/guard-rspec]
+- {guard-livereload}[http://github.com/guard/guard-livereload]
guard ideas:
- guard-spork
-- guard-livereload
- guard-cucumber
- guard-test
- guard-sass
- guard-bundler
- others ideas?
@@ -63,10 +67,10 @@
Add it to your Gemfile (inside test group):
gem '<guard-name>'
-Add guard definition to your Guardfile with:
+Add guard definition to your Guardfile by running this command:
guard init <guard-name>
You are good to go!
\ No newline at end of file