projects
/
ruby-ecore.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-ecore.git]
/
README
diff --git
a/README
b/README
index e8004b07a54a86db82cf0069bf2fa7b4ed9d18a2..caf844e3f6fc9ba6abf9d4193d370199df6d914a 100644
(file)
--- a/
README
+++ b/
README
@@
-1,16
+1,17
@@
-ruby-ecore - Ruby bindings for Ecore
-==================================
-
-
-About
------
+= ruby-ecore - Ruby bindings for Ecore
ruby-ecore is a set of Ruby language bindings for Enlightenment's Core
library, Ecore.
ruby-ecore is a set of Ruby language bindings for Enlightenment's Core
library, Ecore.
+ruby-ecore is maintained by:
+
+:include: AUTHORS
-Installation
-------------
+==License
+
+ruby-ecore is available under the GNU LGPL.
+
+== Installation
Run "rake install" to install ruby-ecore.
If you didn't install Ecore to /usr/local, execute the following line
Run "rake install" to install ruby-ecore.
If you didn't install Ecore to /usr/local, execute the following line
@@
-18,14
+19,9
@@
instead:
ECORE_PREFIX=/prefix/ecore/is/installed/in rake install
ECORE_PREFIX=/prefix/ecore/is/installed/in rake install
+== Documentation
-Documentation
--------------
-
-To create the HTML documentation for ruby-ecore, 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-ecore.
-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/ecore
+You can recreate the documentation by running "rake rdoc".