Use RDoc for README.
[ruby-edje.git] / README
1 = ruby-edje - Ruby bindings for Edje
2
3 ruby-edje is a set of Ruby language bindings for Enlightenment's Layout
4 library, edje.
5
6 == Installation
7
8 Run "rake install" to install ruby-edje.
9 If you didn't install Edje to /usr/local, execute the following line
10 instead:
11
12 EDJE_PREFIX=/prefix/edje/is/installed/in rake install
13
14 == Documentation
15
16 To create the HTML documentation for ruby-edje, a patched version of
17 rdoc is required. The necessary patches can be found at
18 http://code-monkey.de/?patches
19
20 After you've patched rdoc, please run "make doc" to create the HTML.
21 The docs can also be found at
22 http://code-monkey.de/ruby-efl-docs/edje