Skip to content

Commit

Permalink
Close GH-39: Clarify Compass's relationship to Sass. Fixes #26
Browse files Browse the repository at this point in the history
  • Loading branch information
robwierzbowski authored and sindresorhus committed Apr 11, 2013
1 parent 0cb73ed commit cbf44b8
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# grunt-contrib-compass [![Build Status](https://secure.travis-ci.org/gruntjs/grunt-contrib-compass.png?branch=master)](http://travis-ci.org/gruntjs/grunt-contrib-compass)

> Compile Compass to CSS
> Compile Sass to CSS using Compass
[Compass](http://compass-style.org/) is an open-source authoring framework for the [Sass](http://sass-lang.com/) css preprocessor. It helps you build stylesheets faster with a huge library of Sass mixins and functions, advanced tools for spriting, and workflow improvements including file based Sass configuration and a simple pattern for building and using Compass extensions.

## Getting Started
This plugin requires Grunt `~0.4.0`
Expand All @@ -25,9 +25,9 @@ grunt.loadNpmTasks('grunt-contrib-compass');
## Compass task
_Run this task with the `grunt compass` command._

This task requires you to have [Ruby](http://www.ruby-lang.org/en/downloads/) and [Compass](http://compass-style.org/install/). If you're on OS X or Linux you probably already have Ruby installed, try `ruby -v` in your terminal. When you've confirmed you have Ruby installed, run `gem update --system && gem install compass` to install Compass.
This task requires you to have [Ruby](http://www.ruby-lang.org/en/downloads/), [Sass](http://sass-lang.com/tutorial.html), and [Compass](http://compass-style.org/install/) installed. If you're on OS X or Linux you probably already have Ruby installed; test with `ruby -v` in your terminal. When you've confirmed you have Ruby installed, run `gem update --system && gem install compass` to install Compass and Sass.

Compass operates on a folder level, because of this you don't specify any src/dest, but instead define the `sassDir` and `cssDir` options.
Compass operates on a folder level. Because of this you don't specify any src/dest, but instead define the `sassDir` and `cssDir` options.

_This plugin is only compatible with Grunt `>= 0.4.x`._

Expand Down
6 changes: 4 additions & 2 deletions docs/compass-overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
This task requires you to have [Ruby](http://www.ruby-lang.org/en/downloads/) and [Compass](http://compass-style.org/install/). If you're on OS X or Linux you probably already have Ruby installed, try `ruby -v` in your terminal. When you've confirmed you have Ruby installed, run `gem update --system && gem install compass` to install Compass.
[Compass](http://compass-style.org/) is an open-source authoring framework for the [Sass](http://sass-lang.com/) css preprocessor. It helps you build stylesheets faster with a huge library of Sass mixins and functions, advanced tools for spriting, and workflow improvements including file based Sass configuration and a simple pattern for building and using Compass extensions.

Compass operates on a folder level, because of this you don't specify any src/dest, but instead define the `sassDir` and `cssDir` options.
This task requires you to have [Ruby](http://www.ruby-lang.org/en/downloads/), [Sass](http://sass-lang.com/tutorial.html), and [Compass](http://compass-style.org/install/) installed. If you're on OS X or Linux you probably already have Ruby installed; test with `ruby -v` in your terminal. When you've confirmed you have Ruby installed, run `gem update --system && gem install compass` to install Compass and Sass.

Compass operates on a folder level. Because of this you don't specify any src/dest, but instead define the `sassDir` and `cssDir` options.

_This plugin is only compatible with Grunt `>= 0.4.x`._
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "grunt-contrib-compass",
"description": "Compile Compass to CSS",
"description": "Compile Sass to CSS using Compass",
"version": "0.1.3",
"homepage": "https://github.com/gruntjs/grunt-contrib-compass",
"author": {
Expand Down
2 changes: 1 addition & 1 deletion tasks/compass.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ module.exports = function (grunt) {
child.stderr.pipe(process.stderr);
}

grunt.registerMultiTask('compass', 'Compile Compass to CSS', function () {
grunt.registerMultiTask('compass', 'Compile Sass to CSS using Compass', function () {
var options = this.options();
var cb = this.async();
// create a temporary config file if there are 'raw' options or
Expand Down
2 changes: 1 addition & 1 deletion test/compass_test.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ exports.compass = {

var actual = grunt.file.read('tmp/compile.css');
var expected = grunt.file.read('test/expected/compile.css');
test.equal(actual, expected, 'should compile Compass to CSS');
test.equal(actual, expected, 'should compile Sass to CSS with Compass');

test.done();
},
Expand Down

0 comments on commit cbf44b8

Please sign in to comment.