README

   1 --
   2 $Id: README 9 2005-03-28 20:54:45Z tilman $
   3 ++
   4
   5 = Redact -- An Edje Compiler written in Ruby
   6
   7 Redact is an Edje[http://enlightenment.org] compiler written in Ruby.
   8 Unlike the official Edje compiler, edje_cc, Redact doesn't read
   9 EDC code - it reads Ruby code instead. This means that Redact will allow
  10 you to write Edjes in a full-blown programming language.
  11
  12 So why is this a good thing?
  13
  14 With edje_cc, the only way to automate the creation of parts and/or
  15 programs is to use CPP macros, which are very limited feature-wise
  16 and hard to debug.
  17
  18 Also, it means that syntax errors won't go unnoticed anymore :)
  19
  20 Redact is maintained by:
  21
  22 :include: AUTHORS
  23
  24 == License
  25
  26 Redact is available under an MIT-style license.
  27
  28 :include: COPYING
  29
  30 == Download
  31
  32 The latest version of Redact can be found at
  33 http://code-monkey.de/projects/redact.html
  34
  35 Online documentation is available at
  36 http://code-monkey.de/docs/redact
  37
  38 == Dependencies
  39
  40 Redact depends on Rake[http://rake.rubyforge.org],
  41 Ruby-EET[http://code-monkey.de/projects/ruby-eet.html] and
  42 Imlib2-Ruby[http://pablotron.org/software/imlib2-ruby].
  43
  44 == Installation
  45
  46 Run "rake install" to install Redact.
  47
  48 == Usage
  49
  50 There's no tutorial on Redact yet, but you can have a look at
  51 test/crossfade.rb to get started.
  52 See the {online documentation}[http://code-monkey.de/docs/redact] for
  53 information about the Redact API.
  54
  55 To compile your Edje, just run "redact foo.rb -o foo.edj".