projects
/
ruby-edje.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Updated README wrt documentation and other stuff.
[ruby-edje.git]
/
README
diff --git
a/README
b/README
index 8b056775599717f5f82d20c4e6505bd223855de5..010b1ac8f5d926488b94a0d74957f1b73aff1c04 100644
(file)
--- a/
README
+++ b/
README
@@
-1,16
+1,17
@@
-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 a set of Ruby language bindings for Enlightenment's Layout
library, edje.
+ruby-edje is maintained by:
+
+:include: AUTHORS
-Installation
-------------
+== 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
Run "rake install" to install ruby-edje.
If you didn't install Edje to /usr/local, execute the following line
@@
-18,14
+19,9
@@
instead:
EDJE_PREFIX=/prefix/edje/is/installed/in rake install
EDJE_PREFIX=/prefix/edje/is/installed/in rake install
+== 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".