Skip to content

Commit

Permalink
updated readme for windows users
Browse files Browse the repository at this point in the history
  • Loading branch information
jlipps committed Oct 3, 2012
1 parent 9f68058 commit 504aa96
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Expand Up @@ -21,7 +21,15 @@ details.
Quickstart
----------
Check out [sausage-bun](http://github.com/jlipps/sausage-bun). It's a one-line
script you can run via curl and PHP to get everything going.
script you can run via curl and PHP to get everything going. For example:

```
curl -s https://raw.github.com/jlipps/sausage-bun/master/givememysausage.php | php
```

_Note_: if you are a Windows user who's not using Cygwin, it'll take a little
extra work to set you up---please see the [sausage-bun
README](http://github.com/jlipps/sausage-bun)

Manual Install
------------
Expand All @@ -38,7 +46,7 @@ file in your project root. A minimal example composer.json would look like:
}
```

If you haven't already got Composer installed, get it thusly:
If you haven't already got Composer installed, get it thusly (for *nix/Mac):

curl -s http://getcomposer.org/installer | php

Expand All @@ -53,6 +61,10 @@ account:

vendor/bin/sauce_config YOUR_SAUCE_USERNAME YOUR_SAUCE_API_KEY

(Or for Windows):

vendor\bin\sauce_config.bat YOUR_SAUCE_USERNAME YOUR_SAUCE_API_KEY

(It's a Composer convention for package binaries to be located in `vendor/bin`;
you can always symlink things elsewhere if it's more convenient).

Expand All @@ -71,6 +83,10 @@ If everything's set up correctly, you should be able to run this:

vendor/bin/phpunit vendor/sauce/sausage/WebDriverDemo.php

(Or for Windows):

vendor\bin\phpunit.bat vendor\sauce\sausage\WebDriverDemo.php

And start seeing tests pass. (While the tests are running, you can check on
their progress by going to your [Sauce tests
page](http://saucelabs.com/tests))
Expand All @@ -82,6 +98,10 @@ do it all at once! Try this:

vendor/bin/paraunit -p2 --path=vendor/sauce/sausage/WebDriverDemo.php

(Or for Windows):

vendor\bin\paraunit.bat --processes=2 --path=vendor\sauce\sausage\WebDriverDemo.php

Now they'll finish twice as fast! (And if you get a [Sauce Labs
account](http://saucelabs.com/pricing), you can
bump up that concurrency to 4, 10, 20, 30, or more!)
Expand Down Expand Up @@ -235,6 +255,10 @@ credentials, starting sauce connect is as easy as:

vendor/bin/sauce_connect

(Or for Windows):

vendor\bin\sauce_connect.bat

Run that and you'll be testing against your local test server in no time!

Contributors
Expand Down

0 comments on commit 504aa96

Please sign in to comment.