--
$Id: README 14 2005-03-29 16:25:21Z tilman $
++

= Redact -- An Edje Compiler written in Ruby

Redact is an Edje[http://enlightenment.org] compiler written in Ruby.
Unlike the official Edje compiler, edje_cc, Redact doesn't read
EDC code - it reads Ruby code instead. This means that Redact will allow
you to write Edjes in a full-blown programming language.

So why is this a good thing?

With edje_cc, the only way to automate the creation of parts and/or
programs is to use CPP macros, which are very limited feature-wise
and hard to debug.

Also, it means that syntax errors won't go unnoticed anymore :)

Redact is maintained by:

:include: AUTHORS

== License

Redact is available under an MIT-style license.

:include: COPYING

== Download

The latest version of Redact can be found at
http://code-monkey.de/projects/redact.html

Online documentation is available at
http://code-monkey.de/docs/redact

== Dependencies

Redact depends on Rake[http://rake.rubyforge.org] 0.5.0 or greater,
Ruby-EET[http://code-monkey.de/projects/ruby-eet.html] and
Imlib2-Ruby[http://pablotron.org/software/imlib2-ruby].

== Installation

Run "rake install" to install Redact.

== Usage

There's no tutorial on Redact yet, but you can have a look at
test/crossfade.rb to get started.
See the {online documentation}[http://code-monkey.de/docs/redact] for
information about the Redact API.

To compile your Edje, just run "redact foo.rb -o foo.edj".