Skip to content

Commit b00159c

Browse files
committed
Freshen up the README
1 parent 6faa379 commit b00159c

File tree

1 file changed

+17
-20
lines changed

1 file changed

+17
-20
lines changed

README.markdown

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,47 +3,44 @@
33
This repository is for anyone interested in contributing to rspec-2 or
44
rspec-rails-2.
55

6-
## Setting up the environment
6+
## Environment
77

8-
### System pre-reqs:
8+
### System
99

1010
git
1111
sqlite3 # for rspec-rails
1212

13-
### Environment
13+
### Ruby
1414

15-
The safest bet is to use rvm with an rvm installed ruby (not system ruby) and
16-
a clean gemset dedicated to rspec-dev:
15+
The safest bet is to use [rvm](https://github.com/wayneeseguin/rvm) with an rvm
16+
installed ruby (not system ruby) and a clean gemset dedicated to rspec-dev:
1717

18-
rvm 1.9.2@rspec-dev --create # or whatever version of Ruby you prefer
18+
rvm 1.9.3@rspec-dev --create # or whatever version of Ruby you prefer
1919

20-
Windows users can use pik instead of rvm.
20+
[rbenv](https://github.com/sstephenson/rbenv) is also supported.
21+
22+
Windows users can use [pik](https://github.com/vertiginous/pik).
2123

2224
If you use a different Ruby version manager (or none at all), the important
2325
thing is that you have a sandboxed gem environment that does not require you to
2426
use sudo to install gems, and has no rspec libraries installed.
2527

26-
### required gems
28+
### Bundler
2729

28-
You just need to install bundler to start:
30+
Bundler is required for dependency management. Install it first:
2931

3032
gem install bundler
3133

32-
Bundler will only install if you have RubyGems 1.3.6 or later, so you may need
33-
to update RubyGems first:
34-
35-
gem update --system
36-
37-
### Once bundler installed
34+
### rspec-dev
3835

39-
Once you have all the pre-reqs listed above, here's all you need to do
40-
to set up your environment:
36+
Once all of the pre-reqs above are taken care of, run these steps to get
37+
bootstrapped:
4138

4239
git clone git://github.com/rspec/rspec-dev.git
4340
cd rspec-dev
4441
bundle install --binstubs
4542
bin/rake setup
46-
bin/rake
43+
bin/rake # runs tests in every repository
4744

4845
If all goes well, you'll end up seeing a lot of passing cucumber features
4946
and rspec code examples. You'll also have a directory structure that looks
@@ -71,8 +68,8 @@ Once you've set up the environment, you'll need to cd into the working
7168
directory of whichever repo you want to work in. From there you can run the
7269
specs and cucumber features, and make patches.
7370

74-
NOTE: You do not need to use rspec-dev to work on a specific RSpec repo. You can treat
75-
each RSpec repo as an independent project.
71+
NOTE: You do not need to use rspec-dev to work on a specific RSpec repo. You
72+
can treat each RSpec repo as an independent project.
7673

7774
## Patches
7875

0 commit comments

Comments
 (0)