|
3 | 3 | This repository is for anyone interested in contributing to rspec-2 or
|
4 | 4 | rspec-rails-2.
|
5 | 5 |
|
6 |
| -## Setting up the environment |
| 6 | +## Environment |
7 | 7 |
|
8 |
| -### System pre-reqs: |
| 8 | +### System |
9 | 9 |
|
10 | 10 | git
|
11 | 11 | sqlite3 # for rspec-rails
|
12 | 12 |
|
13 |
| -### Environment |
| 13 | +### Ruby |
14 | 14 |
|
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: |
17 | 17 |
|
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 |
19 | 19 |
|
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). |
21 | 23 |
|
22 | 24 | If you use a different Ruby version manager (or none at all), the important
|
23 | 25 | thing is that you have a sandboxed gem environment that does not require you to
|
24 | 26 | use sudo to install gems, and has no rspec libraries installed.
|
25 | 27 |
|
26 |
| -### required gems |
| 28 | +### Bundler |
27 | 29 |
|
28 |
| -You just need to install bundler to start: |
| 30 | +Bundler is required for dependency management. Install it first: |
29 | 31 |
|
30 | 32 | gem install bundler
|
31 | 33 |
|
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 |
38 | 35 |
|
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: |
41 | 38 |
|
42 | 39 | git clone git://github.com/rspec/rspec-dev.git
|
43 | 40 | cd rspec-dev
|
44 | 41 | bundle install --binstubs
|
45 | 42 | bin/rake setup
|
46 |
| - bin/rake |
| 43 | + bin/rake # runs tests in every repository |
47 | 44 |
|
48 | 45 | If all goes well, you'll end up seeing a lot of passing cucumber features
|
49 | 46 | 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
|
71 | 68 | directory of whichever repo you want to work in. From there you can run the
|
72 | 69 | specs and cucumber features, and make patches.
|
73 | 70 |
|
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. |
76 | 73 |
|
77 | 74 | ## Patches
|
78 | 75 |
|
|
0 commit comments