X-Git-Url: http://git.code-monkey.de/?p=ruby-eet.git;a=blobdiff_plain;f=README;h=b9dcf66456f029388946a2e2c8c56c75b7b57d60;hp=55ce2719645ae84987d7b944202f3fa0d0ec827e;hb=HEAD;hpb=f54bec7b431be7885c49b2077e9116898298d2dd diff --git a/README b/README index 55ce271..b9dcf66 100644 --- a/README +++ b/README @@ -1,36 +1,36 @@ --- -$Id: README 1 2005-03-26 01:45:38Z tilman $ -++ += Ruby-EET -- Ruby bindings for EET -= ruby-eet -- Ruby bindings for EET - -ruby-eet allows you to dump Ruby objects to disk in the EET file format. -Compatibility with EET Data Descriptors, as used in the C API of libeet, +Ruby-EET allows you to read and write EET[http://enlightenment.org] files +from Ruby code. +Support for Ruby object serialization to EDD (EET Data Descriptor) format is given. -ruby-eet is maintained by: +Ruby-EET is maintained by: :include: AUTHORS == License -ruby-eet is available under an MIT-style license. +Ruby-EET is available under an MIT-style license. :include: COPYING == Download -The latest version of ruby-eet can be found at -http://code-monkey.de/projects/ruby-efl.html +The latest version of Ruby-EET can be found at +http://code-monkey.de/pages/ruby-eet + +Online documentation is available at +http://docs.code-monkey.de/ruby-eet == Dependencies -ruby-eet depends on Rake[http://rake.rubyforge.org] 0.5.0 or greater +Ruby-EET depends on Rake[http://rake.rubyforge.org] 0.5.0 or greater and EET[http://www.enlightenment.org]. == Installation -Run "rake install" to install ruby-eet. +Run "rake install" to install Ruby-EET. == Usage @@ -49,7 +49,7 @@ Eet::File#write_image. === Serializing objects -ruby-eet also supports the serialization of objects which uses the same +Ruby-EET also supports the serialization of objects which uses the same format as the C API uses for its EET data descriptors. At the time of this writing, deserialization, i.e. read support, isn't implemented yet, though.