Skip to content

Commit

Permalink
explain README links to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dchelimsky committed Nov 25, 2010
1 parent 285b438 commit 3d0ac2b
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.markdown → README.md
Expand Up @@ -4,8 +4,16 @@ Behaviour Driven Development for Ruby

## Documentation

* [Cucumber features](http://relishapp.com/rspec/rspec-core/v/2-0)
* [RDoc](http://rubydoc.info/gems/rspec-core/2.0.1/frames)
The [Cucumber features](http://relishapp.com/rspec/rspec-core/v/2-0) are the
most comprehensive and up-to-date docs for end-users.

The [RDoc](http://rubydoc.info/gems/rspec-core/2.0.1/frames) provides
additional information for contributors and/or extenders.

All of the documentation is open source and a work in progress. If you find it
lacking or confusing, you can help improve it by submitting requests and
patches to the [rspec-core issue
tracker](https://github.com/rspec/rspec-core/issues).

## Install

Expand Down Expand Up @@ -54,7 +62,7 @@ Be sure to require the implementation file in the spec:
require "calculator"

Now run the spec again, and watch it pass:

$ rspec spec/calculator_spec.rb
.

Expand Down

0 comments on commit 3d0ac2b

Please sign in to comment.