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

Fix README for rubydoc [ci skip]

Browse Source
This commit is contained in:
Thibaud Guillaume-Gentil 2011-10-12 22:22:44 +02:00
parent 5111e8594e
commit 50b35cc99c
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -49,6 +49,7 @@ Add the guards you need to your Guardfile (see the existing guards below).
Now, be sure to read the particular instructions for your operating system: [Mac OS X](#mac) | [Linux](#linux) | [Windows](#win) Now, be sure to read the particular instructions for your operating system: [Mac OS X](#mac) | [Linux](#linux) | [Windows](#win)
<a name="mac" /> <a name="mac" />
### On Mac OS X ### On Mac OS X
Install the rb-fsevent gem for [FSEvent](http://en.wikipedia.org/wiki/FSEvents) support: Install the rb-fsevent gem for [FSEvent](http://en.wikipedia.org/wiki/FSEvents) support:
@ -89,6 +90,7 @@ Finally you have to add your Growl library of choice to your Gemfile:
Have a look at the [Guard Wiki](https://github.com/guard/guard/wiki/Which-Growl-library-should-I-use) for more information. Have a look at the [Guard Wiki](https://github.com/guard/guard/wiki/Which-Growl-library-should-I-use) for more information.
<a name="linux" /> <a name="linux" />
### On Linux ### On Linux
Install the [rb-inotify gem](https://rubygems.org/gems/rb-inotify) for [inotify](http://en.wikipedia.org/wiki/Inotify) support: Install the [rb-inotify gem](https://rubygems.org/gems/rb-inotify) for [inotify](http://en.wikipedia.org/wiki/Inotify) support:
@ -105,6 +107,7 @@ And add them to your Gemfile:
gem 'libnotify' gem 'libnotify'
<a name="win" /> <a name="win" />
### On Windows ### On Windows
Install the [rb-fchange gem](https://rubygems.org/gems/rb-fchange) for [Directory Change Notification](http://msdn.microsoft.com/en-us/library/aa365261\(VS.85\).aspx) support: Install the [rb-fchange gem](https://rubygems.org/gems/rb-fchange) for [Directory Change Notification](http://msdn.microsoft.com/en-us/library/aa365261\(VS.85\).aspx) support:
@ -189,27 +192,22 @@ Guard can use a Guardfile not located in the current directory:
Guard can optionally watch all file modifications like moves or deletions with: Guard can optionally watch all file modifications like moves or deletions with:
``` bash $ guard start -A
$ guard start -A $ guard start --watch-all-modifications
$ guard start --watch-all-modifications
```
### `-i`/`--no-interactions` option ### `-i`/`--no-interactions` option
Turn off completely any Guard terminal [interactions](#interactions) with: Turn off completely any Guard terminal [interactions](#interactions) with:
``` bash $ guard start -A
$ guard start -i $ guard start --watch-all-modifications
$ guard start --no-interactions
```
An exhaustive list of options is available with: An exhaustive list of options is available with:
``` bash $ guard help [TASK]
$ guard help [TASK]
```
<a name="interactions" /> <a name="interactions" />
Interactions Interactions
------------ ------------