github-migration/guard-rocco
1
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

Update documentation to tidy things up and explain run_all option

Browse Source
This commit is contained in:
Jean Mertz 2011-11-13 14:28:15 +01:00
parent 5411646f44
commit 48f92f4452
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,15 +1,21 @@
It's a [Guard](http://github.com/guard/guard) for the [Rocco](http://github.com/rtomayko/rocco) documentation system!
guard 'rocco' do
``` ruby
# default values
guard 'rocco', :run_all => [:start, :change], :dir => 'doc', :stylesheet => 'http://jashkenas.github.com/docco/resources/docco.css' do
watch(%r{^app/.*\.(rb|coffee)$})
watch(%r{^lib/.*\.rb$})
end
end
```
Options:
* `:dir` specifies the output dir (default `doc`)
* `:stylesheet` specifies a custom stylesheet to use (default is
http://jashkenas.github.com/docco/resources/docco.css)
* `:run_on` specifies when to update the docs
* `:start` - run on all documentation when the guard starts
* `:change` - run when watched files change
* `:reload` - run when the guard is reloaded
* `:all` - run when running all the guards
* `:dir` specifies the output dir
* `:stylesheet` specifies a custom stylesheet to use
`gem install guard-rocco` or Bundle it up with `gem 'guard-rocco'`. Then `guard init rocco`. Yeah!