X-Git-Url: http://git.code-monkey.de/?p=ruby-edje.git;a=blobdiff_plain;f=README;h=56786540a4e045c515e41902911f4984c5d876c4;hp=8b056775599717f5f82d20c4e6505bd223855de5;hb=HEAD;hpb=fae1e0d0b39467848a15f5cf94dbf3aa8c25bc22 diff --git a/README b/README index 8b05677..5678654 100644 --- a/README +++ b/README @@ -1,31 +1,23 @@ -ruby-edje - Ruby bindings for Edje -================================== - - -About ------ += 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: -Installation ------------- +:include: AUTHORS -Run "rake install" to install ruby-edje. -If you didn't install Edje to /usr/local, execute the following line -instead: +== License -EDJE_PREFIX=/prefix/edje/is/installed/in rake install +ruby-edje is available under the GNU LGPL. +== Installation + +Run "rake install" to install ruby-edje. -Documentation -------------- +== 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 +Online documentation is available at +http://docs.code-monkey.de/ruby-edje. -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 +You can recreate the documentation by running "rake rdoc".