Updated README wrt documentation and other stuff.

[ruby-ecore.git] / README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..caf844e3f6fc9ba6abf9d4193d370199df6d914a 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,27 @@
+= ruby-ecore - Ruby bindings for Ecore
+
+ruby-ecore is a set of Ruby language bindings for Enlightenment's Core
+library, Ecore.
+
+ruby-ecore is maintained by:
+
+:include: AUTHORS
+
+==License
+
+ruby-ecore is available under the GNU LGPL.
+
+== 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
+
+Online documentation is available at
+http://docs.code-monkey.de/ruby-ecore.
+
+You can recreate the documentation by running "rake rdoc".