Updated README wrt documentation and other stuff.

[ruby-ecore.git] / README

diff --git a/README b/README
index aad519d34da157b62b22c57345c84a11cd7871b1..caf844e3f6fc9ba6abf9d4193d370199df6d914a 100644 (file)
--- a/README
+++ b/README
@@ -1,29 +1,27 @@
-$Id: README 60 2004-08-10 14:12:36Z tilman $
+= ruby-ecore - Ruby bindings for Ecore
 
-ruby-ecore - Ruby bindings for Ecore
-==================================
+ruby-ecore is a set of Ruby language bindings for Enlightenment's Core
+library, Ecore.
 
+ruby-ecore is maintained by:
 
-About
------
+:include: AUTHORS
 
-ruby-ecore is a set of Ruby language bindings for Enlightenment's Core
-library, Ecore.
+==License
 
+ruby-ecore is available under the GNU LGPL.
 
-Installation
-------------
+== Installation
 
-Please see INSTALL.
+Run "rake install" to install ruby-ecore.
+If you didn't install Ecore to /usr/local, execute the following line
+instead:
 
+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".