Use RDoc for README.

[ruby-edje.git] / README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..a557c6160f411a793a62bec505cd7daa3777d15d 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,22 @@
+= ruby-edje - Ruby bindings for Edje
+
+ruby-edje is a set of Ruby language bindings for Enlightenment's Layout
+library, edje.
+
+== Installation
+
+Run "rake install" to install ruby-edje.
+If you didn't install Edje to /usr/local, execute the following line
+instead:
+
+EDJE_PREFIX=/prefix/edje/is/installed/in rake 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