X-Git-Url: http://git.code-monkey.de/?a=blobdiff_plain;f=README;h=eefa2d1df22311171ee2f7e0ed92e5fdd4611fb1;hb=ec6b71e7bea2d0d00b4899e68dd17f0fc24c5ba7;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=57899c370e21841e01a3cecd3ad976dca250cf07;p=ruby-evas.git

diff --git a/README b/README
index e69de29..eefa2d1 100644
--- a/README
+++ b/README
@@ -0,0 +1,22 @@
+= ruby-evas - Ruby bindings for Evas
+
+ruby-evas is a set of Ruby language bindings for Enlightenment's Canvas
+library, Evas.
+
+== Installation
+
+Run "rake install" to install ruby-evas.
+If you didn't install Evas to /usr/local, execute the following line
+instead:
+
+EVAS_PREFIX=/prefix/evas/is/installed/in rake install
+
+== Documentation
+
+To create the HTML documentation for ruby-evas, 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/evas