Skip to content
Browse files

Update read me to point to newb script

  • Loading branch information...
1 parent e66b84f commit 43649abc406eb28cd2b6e3a804c50f547893a263 @matschaffer committed Feb 11, 2012
Showing with 3 additions and 11 deletions.
  1. +3 −11 README.rdoc
View
14 README.rdoc
@@ -54,20 +54,12 @@ This uploads all of your cookbooks in addition to a patch that allows you to use
== DEVELOPMENT
-I recommend using Bundler for development. It's also useful to specify binstubs. The +.gitignore+ file contains an entry for the +b+ directory intended for binstubs. This way you can run +./b/knife+ to do full testing on knife-solo commands without having to actually install the gem.
-
-To run tests, run +rake+ after running +bundle+.
-
-To run integration tests run +rake test:integration+. There is some setup to do first though:
-
-* Put +export AWS_ACCESS_KEY=yourAWSkey+ and +export AWS_SECRET_KEY=yourAWSsecret+ in your shell profile
-* On EC2 create a keypair called knife-solo and copy the key to +~/.ssh/knife-solo.pem+ on your machine
-* Make sure you have netcat installed (+which nc+ to test)
+Get set up by running +./script/newb+ this will do some of the steps and guide you through the rest. If it doesn't run for you, feel free to {file an issue}[https://github.com/matschaffer/knife-solo/issues].
When running integration tests you can specify VERBOSE=true as an environment variable to enable verbose output. All integration testing output is sent to the log directory into a file that matches matches the test case name.
You can also specify SKIP_DESTROY=true to leave the EC2 instances running after test completion. Note that this is for debugging purposes and re-running the test will not re-use old instances. Please clean them up manually if you cancel the test or specify SKIP_DESTROY.
-To make an integration test, create a file in the +test/integration+ directory and a test class that inherits from +IntegrationTest+ and includes +IntegrationTest::BasicPrepareAndCook+. You can override methods as necessary, but generally you only need to override +user+ and +image_id+ to specify the user name and AMI ID.
+To make an integration test, create a file in the +test/integration+ directory and a test class that inherits from +IntegrationTest+ and includes +IntegrationTest::BasicPrepareAndCook+ or other test cases. You can override methods as necessary, but generally you only need to override +user+ and +image_id+ to specify the user name and AMI ID.
-If you're interested in contributing, contact me via github or have a look at the {github issues page}[https://github.com/matschaffer/knife-solo/issues].
+If you're interested in contributing, contact me via GitHub or have a look at the {GitHub issues page}[https://github.com/matschaffer/knife-solo/issues].

0 comments on commit 43649ab

Please sign in to comment.
Something went wrong with that request. Please try again.