Added a publish task.

[ruby-edje.git] / README

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