Permalink
Browse files

add DEV-README.md

Would have prefered to call it README-DEV, but yard picks that up and
won't ignore it even if I tell it to :(
  • Loading branch information...
1 parent fcb8455 commit 87d34b2a38ce3054e7084d54b2ce4502c0243bf7 @dchelimsky dchelimsky committed Nov 26, 2011
Showing with 30 additions and 0 deletions.
  1. +28 −0 DEV-README.md
  2. +2 −0 Gemfile-custom.sample
View
@@ -0,0 +1,28 @@
+## Set up the dev environment
+
+ git clone git://github.com/rspec/rspec-core.git
+ cd rspec-core
+ gem install bundler
+ bundle install
+
+Now you should be able to run any of:
+
+ rake
+ rake spec
+ rake cucumber
+
+Or, if you prefer to use the rspec and cucumber commands directly, you can either:
+
+ bundle exec rspec
+
+Or ...
+
+ bundle install --binstubs
+ bin/rspec
+
+## Customize the dev enviroment
+
+The Gemfile includes the gems you'll need to be able to run specs. If you want
+to customize your dev enviroment with additional tools like guard or
+ruby-debug, add any additional gem declarations to Gemfile-custom (see
+Gemfile-custom.sample for some examples).
View
@@ -21,6 +21,8 @@ group :development do
gem 'ruby-debug-base19', '0.11.25'
gem 'linecache19', '0.5.12'
when '1.9.3'
+ # NOTE - see http://blog.wyeworks.com/2011/11/1/ruby-1-9-3-and-ruby-debug
+ # for help setting up ruby-debug19 on ruby 1.9.3
gem 'ruby-debug19', '0.11.6'
gem 'ruby-debug-base19', '0.11.26'
gem 'linecache19', '0.5.13'

0 comments on commit 87d34b2

Please sign in to comment.