From: Tilman Sauerbeck <tilman@code-monkey.de>
Date: Mon, 28 Mar 2005 20:54:45 +0000 (+0000)
Subject: Added basic documentation.
X-Git-Tag: redact-0.1.0~7
X-Git-Url: http://git.code-monkey.de/?p=redact.git;a=commitdiff_plain;h=8488c1e2c868cb7800f7084736597e03d9ed0904

Added basic documentation.
---

diff --git a/ChangeLog b/ChangeLog
index 96e74b8..85dfd23 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,11 +1,12 @@
 --
-$Id: ChangeLog 8 2005-03-28 18:11:12Z tilman $
+$Id: ChangeLog 9 2005-03-28 20:54:45Z tilman $
 ++
 
 2005-03-28 Tilman Sauerbeck (tilman at code-monkey de)
         * lib/redact/app.rb: Tweaked "redact --version" output
         * Rakefile, test/test_basic.rb: Use 'edj' instead of 'eet'
           as the extension for the test Edjes
+        * README: Added basic documentation
 
 2005-03-26 Tilman Sauerbeck (tilman at code-monkey de)
         * lib/redact/app.rb: Use Tempfile's for the Embryo source- and
diff --git a/README b/README
new file mode 100644
index 0000000..908900a
--- /dev/null
+++ b/README
@@ -0,0 +1,55 @@
+--
+$Id: README 9 2005-03-28 20:54:45Z 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],
+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".