Skip to content

Commit

Permalink
Updating testing & distribution documentation.
Browse files Browse the repository at this point in the history
We've moved to a `Makefile` and some of the documentation fell out of
date. This corrects the outdated docs.
  • Loading branch information
jish committed Sep 16, 2013
1 parent 49de689 commit cb37830
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 8 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,16 @@
# Contributing to Ember Resource

We're glad you're interested in contributing to the Ember Resource project! There are a number of ways in which you can contribute!

* Submit issues to our [issue tracker][1]
* Use Ember Resource in your own project and let us know how it works for you
* Open a pull request and contribute some of your own code

### Pull Requests

We love pull requests. Please make sure to run the tests locally (`open spec/runner.html` for browser tests or `make test` on the command line) before pushing your branch . But don't worry, even if you forget [Travis CI][2] should run the tests on the pull request for you.

Submit your pull request!

[1]: https://github.com/zendesk/ember-resource/issues
[2]: https://travis-ci.org/zendesk/ember-resource/
2 changes: 1 addition & 1 deletion Makefile
Expand Up @@ -14,7 +14,7 @@ jshint: npm_install
$(JSHINT) src/*.js src/vendor/*.js spec/javascripts/*Spec.js

test: jshint npm_install
./node_modules/mocha-phantomjs/bin/mocha-phantomjs spec/suite.html
./node_modules/mocha-phantomjs/bin/mocha-phantomjs spec/runner.html

npm_install:
npm install
Expand Down
21 changes: 14 additions & 7 deletions README.md
Expand Up @@ -178,21 +178,28 @@ describing the action that occurred (one of

## Testing

Currently the command line test runners are in a state of disrepair :( To run
the Ember Resource test suite, just open `spec/runner.html` in your favorite
browser.
Tests can be run from the command line, or in a browser:

### Browser

To run the Ember Resource test suite in a browser, just open `spec/runner.html`
in your favorite browser.

On Mac OS:

open spec/runner.html

### Command line

To run the test suite from the command line run the `make test` command:

make test

## Building a distribution

There is a rake task to generate an asset for distribution.
To build your very own copy of Ember Resource run the `make dist` task:

```
rake dist:build
```
make dist

The output will be put in the `dist/` folder.

Expand Down
File renamed without changes.

0 comments on commit cb37830

Please sign in to comment.