Skip to content
This repository was archived by the owner on Nov 30, 2024. It is now read-only.

Commit 3d0ac2b

Browse files
committed
explain README links to documentation
1 parent 285b438 commit 3d0ac2b

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.markdown renamed to README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,16 @@ Behaviour Driven Development for Ruby
44

55
## Documentation
66

7-
* [Cucumber features](http://relishapp.com/rspec/rspec-core/v/2-0)
8-
* [RDoc](http://rubydoc.info/gems/rspec-core/2.0.1/frames)
7+
The [Cucumber features](http://relishapp.com/rspec/rspec-core/v/2-0) are the
8+
most comprehensive and up-to-date docs for end-users.
9+
10+
The [RDoc](http://rubydoc.info/gems/rspec-core/2.0.1/frames) provides
11+
additional information for contributors and/or extenders.
12+
13+
All of the documentation is open source and a work in progress. If you find it
14+
lacking or confusing, you can help improve it by submitting requests and
15+
patches to the [rspec-core issue
16+
tracker](https://github.com/rspec/rspec-core/issues).
917

1018
## Install
1119

@@ -54,7 +62,7 @@ Be sure to require the implementation file in the spec:
5462
require "calculator"
5563

5664
Now run the spec again, and watch it pass:
57-
65+
5866
$ rspec spec/calculator_spec.rb
5967
.
6068

0 commit comments

Comments
 (0)