Documentation arrived.

[ruby-edje.git] / README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..2022c20530519d750e8985668689d474dbc3564b 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,29 @@
+$Id: README 59 2004-08-10 14:10:31Z tilman $
+
+ruby-edje - Ruby bindings for Edje
+==================================
+
+
+About
+-----
+
+ruby-edje is a set of Ruby language bindings for Enlightenment's Layout
+library, edje.
+
+
+Installation
+------------
+
+Please see INSTALL.
+
+
+Documentation
+-------------
+
+To create the HTML documentation for ruby-edje, a patched version of
+rdoc is required. The necessary patches can be found at
+http://code-monkey.de/?patches
+
+After you've patched rdoc, please run "make doc" to create the HTML.
+The docs can also be found at
+http://code-monkey.de/ruby-efl-docs/edje