Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update README with changes from Guard.

  • Loading branch information...
commit 6b614dc84fe2a4abfc2f6a37a118319ac5f164a4 1 parent fa50578
Michael Kessler netzpirat authored
Showing with 34 additions and 25 deletions.
  1. +34 −25 README.md
59 README.md
View
@@ -9,21 +9,17 @@ If you have any questions please join us on our [Google group](http://groups.goo
## Install
-Please be sure to have [Guard](https://github.com/guard/guard) installed.
+The simplest way to install Guard is to use [Bundler](http://gembundler.com/).
+Please make sure to have [Guard](https://github.com/guard/guard) installed.
-Install the gem:
+Add Guard::Coffeescript to your `Gemfile`:
-```bash
-$ gem install guard-coffeescript
-```
-
-Add it to your `Gemfile`, preferably inside the development group:
-
-```bash
-gem 'guard-coffeescript'
+```ruby
+group :development do
+ gem 'guard-coffeescript'
+end
```
-
-Add guard definition to your `Guardfile` by running this command:
+Add the default Guard::Coffeescript template to your `Guardfile` by running:
```bash
$ guard init coffeescript
@@ -286,21 +282,36 @@ guard 'coffeescript', :output => 'public/javascripts/compiled' do
end
```
+## Issues
+
+You can report issues and feature requests to [GitHub Issues](https://github.com/netzpirat/guard-coffeescript/issues). Try to figure out
+where the issue belongs to: Is it an issue with Guard itself or with a Guard::Cucumber? Please don't
+ask question in the issue tracker, instead join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).
+
+When you file an issue, please try to follow to these simple rules if applicable:
+
+* Make sure you run Guard with `bundle exec` first.
+* Add debug information to the issue by running Guard with the `--debug` option.
+* Add your `Guardfile` and `Gemfile` to the issue.
+* Make sure that the issue is reproducible with your description.
+
## Development
- Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard-coffeescript/master/frames).
- Source hosted at [GitHub](https://github.com/netzpirat/guard-coffeescript).
-- Report issues and feature requests to [GitHub Issues](https://github.com/netzpirat/guard-coffeescript/issues).
-Pull requests are very welcome! Please try to follow these simple "rules", though:
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
-- Please create a topic branch for every separate change you make.
-- Make sure your patches are well tested.
-- Update the README (if applicable).
-- Please **do not change** the version number.
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested.
+* Update the [Yard](http://yardoc.org/) documentation.
+* Update the README.
+* Update the CHANGELOG for noteworthy changes.
+* Please **do not change** the version number.
-For questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard`
-(irc.freenode.net).
+For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).
## Contributors
@@ -312,13 +323,11 @@ For questions please join us on our [Google group](http://groups.google.com/grou
## Acknowledgment
-[Jeremy Ashkenas](http://twitter.com/#!/jashkenas) for [CoffeeScript](http://jashkenas.github.com/coffee-script/),
+* [Jeremy Ashkenas](http://twitter.com/#!/jashkenas) for [CoffeeScript](http://jashkenas.github.com/coffee-script/),
that little language that compiles into JavaScript and makes me enjoy the frontend.
-
-The [Guard Team](https://github.com/guard/guard/contributors) for giving us such a nice piece of software
+* The [Guard Team](https://github.com/guard/guard/contributors) for giving us such a nice piece of software
that is so easy to extend, one *has* to make a plugin for it!
-
-All the authors of the numerous [Guards](https://github.com/guard) available for making the Guard ecosystem
+* All the authors of the numerous [Guards](https://github.com/guard) available for making the Guard ecosystem
so much growing and comprehensive.
## License
Please sign in to comment.
Something went wrong with that request. Please try again.