Skip to content

Commit

Permalink
Add tests/README.md. JohnAlbin#20
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnAlbin committed Jan 20, 2014
1 parent 26cf3fd commit 35775dd
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Tests

The tests for this project are built using Navigator, a Ruby testing framework
for Sass with Compass. https://github.com/Team-Sass/navigator

## Building the test environment

Navigator works through Ruby, so you need to be running Ruby 1.8.7 or greater, and you to install [Bundler](http://bundler.io/) with `gem install bundler` or, for Mac OS X and other systems requiring administrative privileges, `sudo gem install bundler`.

Once Bundler is installed, run `bundle install` to install libraries required by this project.

## Running tests

Once you have everything installed, run `bundle exec rake` to run the tests. This will compile all of the files in your `tests/tests` files into CSS files and compare those files to the files in `tests/controls`. If any of your output file from your tests don't line up with your controls, you'll get a `.diff` file generated of the differences and you'll get a failed assertion. If your Sass won't compile, you'll get a failed assertion.

If you're working off of a known set of good output and you'd like to generate your controls quickly, you can run `bundle exec rake compile`.

0 comments on commit 35775dd

Please sign in to comment.