README

Path: README
Last Update: Tue Mar 27 19:45:56 +0200 2007

Redact — An Edje Compiler written in Ruby

Redact is an Edje 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:

Tilman Sauerbeck (tilman at code-monkey de)

License

Redact is available under an MIT-style license.

Copyright (c) 2005 Tilman Sauerbeck (tilman at code-monkey de)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download

The latest version of Redact can be found at code-monkey.de/pages/redact

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

Dependencies

Redact depends on Rake 0.5.0 or greater, Ruby-EET and 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 for information about the Redact API.

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

[Validate]