Added .gitignore.

[ruby-ecore.git] / README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..e8004b07a54a86db82cf0069bf2fa7b4ed9d18a2 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,31 @@
+ruby-ecore - Ruby bindings for Ecore
+==================================
+
+
+About
+-----
+
+ruby-ecore is a set of Ruby language bindings for Enlightenment's Core
+library, Ecore.
+
+
+Installation
+------------
+
+Run "rake install" to install ruby-ecore.
+If you didn't install Ecore to /usr/local, execute the following line
+instead:
+
+ECORE_PREFIX=/prefix/ecore/is/installed/in rake install
+
+
+Documentation
+-------------
+
+To create the HTML documentation for ruby-ecore, 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/ecore