Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 78 lines (53 sloc) 2.077 kB
3decb38 Throw in a README and LICENSE for good measure
Scott Barron authored
1 # Guard::Rake
2
3 Guard::Rake allows you to automatically run a Rake task when files are
4 modified.
5
6 ## Install
7
8 Please be sure to have [Guard](https://github.com/guard/guard) installed
9 before continuing.
10
11 Install the gem:
12 ```bash
d6cd859 @kossnocorp Fix README source formatting
kossnocorp authored
13 $ gem install guard-rake
14 ```
3decb38 Throw in a README and LICENSE for good measure
Scott Barron authored
15
16 Add it to your `Gemfile`
17
18 ```ruby
19 gem 'guard-rake'
20 ```
21
22 Add the default Guard::Rake template to your `Guardfile` by running this
23 command:
24
25 ```bash
26 $ guard init rake
27 ```
28
29 ## Usage
30
31 Please read the [Guard usage documentation](https://github.com/guard/guard#readme).
32
33 ## Guardfile
34
35 Guard::Rake comes with a default template that looks like this:
36
37 ```ruby
38 guard 'rake', :task => 'doit' do
39 watch(%r{^some_files/.+$})
40 end
f01b694 fix markdown in readme
Scott Barron authored
41 ```
3decb38 Throw in a README and LICENSE for good measure
Scott Barron authored
42
43 This will run the rake task `doit` from your `Rakefile` whenever any of
44 the watched files change.
45
46 ## Development
47
48 - Source hosted at [GitHub](https://github.com/rubyist/guard-rake)
49 - Report issues and feature requests to [GitHub Issues](https://github.com/rubyist/guard-rake/issues)
50
51 Pull requests welcome!
52
53 ## License
54
55 (The MIT License)
56
57 Copyright (c) 2011 Scott Barron
58
59 Permission is hereby granted, free of charge, to any person obtaining
60 a copy of this software and associated documentation files (the
61 'Software'), to deal in the Software without restriction, including
62 without limitation the rights to use, copy, modify, merge, publish,
63 distribute, sublicense, and/or sell copies of the Software, and to
64 permit persons to whom the Software is furnished to do so, subject to
65 the following conditions:
66
67 The above copyright notice and this permission notice shall be
68 included in all copies or substantial portions of the Software.
69
70 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
71 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
72 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
73 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
74 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
75 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
76 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
77
Something went wrong with that request. Please try again.