sxross / breezy

BREEZY 0.1
==========

Breezy is a simple shell script to build and start Adobe AIR applications
created using Haml[1] and Sass[2].


Usage
-----

Put breezy in your path. Standing in the root directory of your project, type:

$ breezy

The following things will happen:

Any Haml files you have will be compiled to html in the same directory as its
source if the html is out of date

Any Sass files you have will be compiled to css in the same directory as its
source if the css is out of date

The application will be started by running the adt command in your path or if
you export ADT_PATH to the environment, that command will be used instead.
ADT_PATH is a full path including 'adt'.

So, e.g.:

$ export ADT_PATH=~/AIR/bin/adt

This script presumes you have defined all your AIR-type stuff in application.xml
and that adt can start it from there.


Options
-------

-r, --root=ROOT_DIRECTORY        The directory to build
-f, --force                      Force complete build -- useful if using Sass 
                                 mixins that create dependencies
-b, --verbose                    Display verbose progress messages. Otherwise just
                                 a line of dots.
-q                               Display a line of dots as a progress indicator.
                                 Opposite of verbose.
    --help                       Show this message
-v, --version                    Show version

A note on the "force" option. If you are creating dependencies by importing files,
such as Sass mixins, and one of the imported files changes, Breezy will not know
about this. Since most people using Sass mixins are rocket scientists and can walk
on water anyhow, they will probably have some keen solution to this.


Requirements
------------

Tested (lightly) on Ruby 1.8.6. Also requires choice gem by defunkt:

$ sudo gem install choice


Other Stuff
-----------

The build script is intended to be used on *nix (i.e., on Macs, Linux) and is
targeted to the HTML/Ajax flavor of AIR application. The build rules are only
for Haml and Sass, but they can be expanded by adding commands to the handler
class. This should work as:

BuildTarget.commands[:red] = {:command => 'red', :target_extension => 'js'}


CHANGELOG
---------

Added command-line parsing, force option, root option, and verbose option.

Bumped version to 0.0.2.


To Do
-----

Make this a gem.


[1] http://haml.hamptoncatlin.com/
[2] http://haml.hamptoncatlin.com/docs/sass