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