Browse files

Added documentation to the template

  • Loading branch information...
oliamb committed Oct 31, 2010
1 parent 74b527b commit 8256423a46992842875f10762f719cedcf9c331b
Showing with 17 additions and 11 deletions.
  1. +3 −4 README.textile
  2. +14 −7 lib/guard/compass/templates/Guardfile
@@ -27,17 +27,16 @@ h2. Configure Guard::Compass plug-in
The default configuration generated by 'guard init compass' looks like this
-bc. guard 'compass' do
- watch('^src/(.*)\.s[ac]ss')
+bc. guard 'compass'
the compass guard accept two options:
* :working_directory: all compass relative path will be computed from there
* :configuration_file: relative or absolute path to your compass configuration file
By default, the working directory is the folder where you run guard in and
-the configuration_file is computed by compass
+the configuration_file is computed by compass. You don't need to define watcher like
+in other Guard plug-in because they are generated from the Compass configuration files.
h2. Roadmap
@@ -1,8 +1,15 @@
-guard 'compass' do
- watch('^src/(.*)\.s[ac]ss')
+# Guard::Compass
+# You don't need to configure watchers for guard 'compass' declaration as they generated
+# from your Compass configuration file. You might need to define the Compass working directory
+# and point to the configuration file depending of your project structure.
+# Available options:
+# * :workging_directory => Define the Compass working directory, relative to the Guardfile directory
+# * :configuration_file => Path to the Compass configuration file, relative to :working_directory
+# Like usual, the Compass configuration path are relative to the :working_directory
-# # Alternative
-# guard 'compass', :workdir => 'not_current_dir', :configuration_file => 'path/to/my/compass_config.rb' do
-# watch('^src/(.*)\.s[ac]ss')
-# end
+# guard 'compass', :working_directory => 'not_current_dir', :configuration_file => 'path/to/my/compass_config.rb'
+guard 'compass'

0 comments on commit 8256423

Please sign in to comment.